DragonNest/Common/SVNLib/doc/group__clnt__sessions.html
2024-12-19 09:48:26 +08:00

281 lines
14 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Subversion: Client session related functions</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>Client session related functions<br>
<small>
[<a class="el" href="group__clnt__support.html">Client supporting subsystem</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__sessions.html#g32b1f7f851452ec8ecc8c2d899de2b0e">svn_client_url_from_path</a> (const char **url, const char *path_or_url, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set <em>*url</em> to the URL for <em>path_or_url</em>. <a href="#g32b1f7f851452ec8ecc8c2d899de2b0e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__sessions.html#g2b70eb45a57b92c0cd807b4122f8acfb">svn_client_root_url_from_path</a> (const char **url, const char *path_or_url, <a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *ctx, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set <em>*url</em> to the repository root URL of the repository in which <em>path_or_url</em> is versioned (or scheduled to be versioned), allocated in <em>pool</em>. <a href="#g2b70eb45a57b92c0cd807b4122f8acfb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__sessions.html#g1c56e13b2ebe543a84155e5b1c73b364">svn_client_uuid_from_url</a> (const char **uuid, const char *url, <a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *ctx, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get repository <em>uuid</em> for <em>url</em>. <a href="#g1c56e13b2ebe543a84155e5b1c73b364"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__sessions.html#gc6fb340ce6837b3287b7bf6f5ff75d2a">svn_client_uuid_from_path</a> (const char **uuid, const char *path, <a class="el" href="group__svn__wc.html#g2c3046ab8806025e6670a763aa223577">svn_wc_adm_access_t</a> *adm_access, <a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *ctx, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the repository <em>uuid</em> for working-copy <em>path</em>, allocated in <em>pool</em>. <a href="#gc6fb340ce6837b3287b7bf6f5ff75d2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__clnt__sessions.html#gb0ca49065b469625d1168896abdd34fc">svn_client_open_ra_session</a> (<a class="el" href="svn__ra_8h.html#c3a7f3c8f2562ed346c2431c4c94f507">svn_ra_session_t</a> **session, const char *url, <a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *ctx, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open an RA session rooted at <em>url</em>, and return it in <em>*session</em>. <a href="#gb0ca49065b469625d1168896abdd34fc"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gb0ca49065b469625d1168896abdd34fc"></a><!-- doxytag: member="svn_client.h::svn_client_open_ra_session" ref="gb0ca49065b469625d1168896abdd34fc" args="(svn_ra_session_t **session, const char *url, svn_client_ctx_t *ctx, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_open_ra_session </td>
<td>(</td>
<td class="paramtype"><a class="el" href="svn__ra_8h.html#c3a7f3c8f2562ed346c2431c4c94f507">svn_ra_session_t</a> **&nbsp;</td>
<td class="paramname"> <em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *&nbsp;</td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open an RA session rooted at <em>url</em>, and return it in <em>*session</em>.
<p>
Use the authentication baton stored in <em>ctx</em> for authentication. <em>*session</em> is allocated in <em>pool</em>.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.3.</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This function is similar to <a class="el" href="svn__ra_8h.html#2543ab564e75c55f801e6ad6dfbf1f7d" title="Open a repository session to repos_URL.">svn_ra_open3()</a>, but the caller avoids having to providing its own callback functions. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g2b70eb45a57b92c0cd807b4122f8acfb"></a><!-- doxytag: member="svn_client.h::svn_client_root_url_from_path" ref="g2b70eb45a57b92c0cd807b4122f8acfb" args="(const char **url, const char *path_or_url, svn_client_ctx_t *ctx, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_root_url_from_path </td>
<td>(</td>
<td class="paramtype">const char **&nbsp;</td>
<td class="paramname"> <em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>path_or_url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *&nbsp;</td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set <em>*url</em> to the repository root URL of the repository in which <em>path_or_url</em> is versioned (or scheduled to be versioned), allocated in <em>pool</em>.
<p>
<em>ctx</em> is required for possible repository authentication.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.5. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g32b1f7f851452ec8ecc8c2d899de2b0e"></a><!-- doxytag: member="svn_client.h::svn_client_url_from_path" ref="g32b1f7f851452ec8ecc8c2d899de2b0e" args="(const char **url, const char *path_or_url, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_url_from_path </td>
<td>(</td>
<td class="paramtype">const char **&nbsp;</td>
<td class="paramname"> <em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>path_or_url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set <em>*url</em> to the URL for <em>path_or_url</em>.
<p>
If <em>path_or_url</em> is already a URL, set <em>*url</em> to <em>path_or_url</em>.<p>
If <em>path_or_url</em> is a versioned item, set <em>*url</em> to <em>path_or_url's</em> entry URL. If <em>path_or_url</em> is unversioned (has no entry), set <em>*url</em> to NULL.
</div>
</div><p>
<a class="anchor" name="gc6fb340ce6837b3287b7bf6f5ff75d2a"></a><!-- doxytag: member="svn_client.h::svn_client_uuid_from_path" ref="gc6fb340ce6837b3287b7bf6f5ff75d2a" args="(const char **uuid, const char *path, svn_wc_adm_access_t *adm_access, svn_client_ctx_t *ctx, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_uuid_from_path </td>
<td>(</td>
<td class="paramtype">const char **&nbsp;</td>
<td class="paramname"> <em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__svn__wc.html#g2c3046ab8806025e6670a763aa223577">svn_wc_adm_access_t</a> *&nbsp;</td>
<td class="paramname"> <em>adm_access</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *&nbsp;</td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the repository <em>uuid</em> for working-copy <em>path</em>, allocated in <em>pool</em>.
<p>
Use <em>adm_access</em> to retrieve the uuid from <em>path's</em> entry; if not present in the entry, then call <a class="el" href="group__clnt__sessions.html#g1c56e13b2ebe543a84155e5b1c73b364" title="Get repository uuid for url.">svn_client_uuid_from_url()</a> to retrieve, using the entry's URL. <em>ctx</em> is required for possible repository authentication.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The only reason this function falls back on <a class="el" href="group__clnt__sessions.html#g1c56e13b2ebe543a84155e5b1c73b364" title="Get repository uuid for url.">svn_client_uuid_from_url()</a> is for compatibility purposes. Old working copies may not have uuids in the entries file. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g1c56e13b2ebe543a84155e5b1c73b364"></a><!-- doxytag: member="svn_client.h::svn_client_uuid_from_url" ref="g1c56e13b2ebe543a84155e5b1c73b364" args="(const char **uuid, const char *url, svn_client_ctx_t *ctx, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_client_uuid_from_url </td>
<td>(</td>
<td class="paramtype">const char **&nbsp;</td>
<td class="paramname"> <em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsvn__client__ctx__t.html">svn_client_ctx_t</a> *&nbsp;</td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get repository <em>uuid</em> for <em>url</em>.
<p>
Use a <em>pool</em> to open a temporary RA session to <em>url</em>, discover the repository uuid, and free the session. Return the uuid in <em>uuid</em>, allocated in <em>pool</em>. <em>ctx</em> is required for possible repository authentication.
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 24 16:18:29 2008 for Subversion by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>