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

264 lines
17 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: Show repository information about a working copy.</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>Show repository information about a working copy.<br>
<small>
[<a class="el" href="group__clnt__wc.html">Client working copy management</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__info__t.html">svn_info_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A structure which describes various system-generated metadata about a working-copy path or URL. <a href="structsvn__info__t.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Info.html#gc719e0656d40ac8e24f6d6cc5adccbe3">svn_info_receiver_t</a> )(void *baton, const char *path, const <a class="el" href="structsvn__info__t.html">svn_info_t</a> *info, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The callback invoked by <a class="el" href="group__Info.html#g32ad0592964eb4778b77f1b324db1721" title="Invoke receiver with receiver_baton to return information about path_or_url in revision...">svn_client_info2()</a>. <a href="#gc719e0656d40ac8e24f6d6cc5adccbe3"></a><br></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__info__t.html">svn_info_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Info.html#g803b08c81d5033e04c3d5dc234066488">svn_info_dup</a> (const <a class="el" href="structsvn__info__t.html">svn_info_t</a> *info, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a duplicate of <em>info</em>, allocated in <em>pool</em>. <a href="#g803b08c81d5033e04c3d5dc234066488"></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__Info.html#g32ad0592964eb4778b77f1b324db1721">svn_client_info2</a> (const char *path_or_url, const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *peg_revision, const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *revision, <a class="el" href="group__Info.html#gc719e0656d40ac8e24f6d6cc5adccbe3">svn_info_receiver_t</a> receiver, void *receiver_baton, <a class="el" href="svn__types_8h.html#21dd8b080111fa6fb5d59156299f3a2c">svn_depth_t</a> depth, const apr_array_header_t *changelists, <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">Invoke <em>receiver</em> with <em>receiver_baton</em> to return information about <em>path_or_url</em> in <em>revision</em>. <a href="#g32ad0592964eb4778b77f1b324db1721"></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__Info.html#g1553de3f015679f608e450692e91a9b9">svn_client_info</a> (const char *path_or_url, const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *peg_revision, const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *revision, <a class="el" href="group__Info.html#gc719e0656d40ac8e24f6d6cc5adccbe3">svn_info_receiver_t</a> receiver, void *receiver_baton, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> recurse, <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">Similar to <a class="el" href="group__Info.html#g32ad0592964eb4778b77f1b324db1721" title="Invoke receiver with receiver_baton to return information about path_or_url in revision...">svn_client_info2()</a> but with <em>changelists</em> passed as <code>NULL</code>, and <em>depth</em> set according to <em>recurse:</em> if <em>recurse</em> is TRUE, <em>depth</em> is <code>svn_depth_infinity</code>, else <code>svn_depth_empty</code>. <a href="#g1553de3f015679f608e450692e91a9b9"></a><br></td></tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="gc719e0656d40ac8e24f6d6cc5adccbe3"></a><!-- doxytag: member="svn_client.h::svn_info_receiver_t" ref="gc719e0656d40ac8e24f6d6cc5adccbe3" args=")(void *baton, const char *path, const svn_info_t *info, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structsvn__error__t.html">svn_error_t</a>*(* <a class="el" href="group__Info.html#gc719e0656d40ac8e24f6d6cc5adccbe3">svn_info_receiver_t</a>)(void *baton, const char *path, const <a class="el" href="structsvn__info__t.html">svn_info_t</a> *info, apr_pool_t *pool) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The callback invoked by <a class="el" href="group__Info.html#g32ad0592964eb4778b77f1b324db1721" title="Invoke receiver with receiver_baton to return information about path_or_url in revision...">svn_client_info2()</a>.
<p>
Each invocation describes <em>path</em> with the information present in <em>info</em>. Note that any fields within <em>info</em> may be NULL if information is unavailable. Use <em>pool</em> for all temporary allocation.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.2. </dd></dl>
<p>Definition at line <a class="el" href="svn__client_8h-source.html#l04197">4197</a> of file <a class="el" href="svn__client_8h-source.html">svn_client.h</a>.</p>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g1553de3f015679f608e450692e91a9b9"></a><!-- doxytag: member="svn_client.h::svn_client_info" ref="g1553de3f015679f608e450692e91a9b9" args="(const char *path_or_url, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_info_receiver_t receiver, void *receiver_baton, svn_boolean_t recurse, 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_info </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">const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *&nbsp;</td>
<td class="paramname"> <em>peg_revision</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *&nbsp;</td>
<td class="paramname"> <em>revision</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Info.html#gc719e0656d40ac8e24f6d6cc5adccbe3">svn_info_receiver_t</a>&nbsp;</td>
<td class="paramname"> <em>receiver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>receiver_baton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>recurse</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>
Similar to <a class="el" href="group__Info.html#g32ad0592964eb4778b77f1b324db1721" title="Invoke receiver with receiver_baton to return information about path_or_url in revision...">svn_client_info2()</a> but with <em>changelists</em> passed as <code>NULL</code>, and <em>depth</em> set according to <em>recurse:</em> if <em>recurse</em> is TRUE, <em>depth</em> is <code>svn_depth_infinity</code>, else <code>svn_depth_empty</code>.
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000082">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.2 API. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g32ad0592964eb4778b77f1b324db1721"></a><!-- doxytag: member="svn_client.h::svn_client_info2" ref="g32ad0592964eb4778b77f1b324db1721" args="(const char *path_or_url, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_info_receiver_t receiver, void *receiver_baton, svn_depth_t depth, const apr_array_header_t *changelists, 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_info2 </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">const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *&nbsp;</td>
<td class="paramname"> <em>peg_revision</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *&nbsp;</td>
<td class="paramname"> <em>revision</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Info.html#gc719e0656d40ac8e24f6d6cc5adccbe3">svn_info_receiver_t</a>&nbsp;</td>
<td class="paramname"> <em>receiver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>receiver_baton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#21dd8b080111fa6fb5d59156299f3a2c">svn_depth_t</a>&nbsp;</td>
<td class="paramname"> <em>depth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const apr_array_header_t *&nbsp;</td>
<td class="paramname"> <em>changelists</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>
Invoke <em>receiver</em> with <em>receiver_baton</em> to return information about <em>path_or_url</em> in <em>revision</em>.
<p>
The information returned is system-generated metadata, not the sort of "property" metadata created by users. See <code><a class="el" href="structsvn__info__t.html" title="A structure which describes various system-generated metadata about a working-copy...">svn_info_t</a></code>.<p>
If both revision arguments are either <code>svn_opt_revision_unspecified</code> or NULL, then information will be pulled solely from the working copy; no network connections will be made.<p>
Otherwise, information will be pulled from a repository. The actual node revision selected is determined by the <em>path_or_url</em> as it exists in <em>peg_revision</em>. If <em>peg_revision-&gt;kind</em> is <code>svn_opt_revision_unspecified</code>, then it defaults to <code>svn_opt_revision_head</code> for URLs or <code>svn_opt_revision_working</code> for WC targets.<p>
If <em>path_or_url</em> is not a local path, then if <em>revision</em> is of kind <code>svn_opt_revision_previous</code> (or some other kind that requires a local path), an error will be returned, because the desired revision cannot be determined.<p>
Use the authentication baton cached in <em>ctx</em> to authenticate against the repository.<p>
If <em>path_or_url</em> is a file, just invoke <em>receiver</em> on it. If it is a directory, then descend according to <em>depth</em>. If <em>depth</em> is <code>svn_depth_empty</code>, invoke <em>receiver</em> on <em>path_or_url</em> and nothing else; if <code>svn_depth_files</code>, on <em>path_or_url</em> and its immediate file children; if <code>svn_depth_immediates</code>, the preceding plus on each immediate subdirectory; if <code>svn_depth_infinity</code>, then recurse fully, invoking <em>receiver</em> on <em>path_or_url</em> and everything beneath it.<p>
<em>changelists</em> is an array of <code>const char *</code> changelist names, used as a restrictive filter on items whose info is reported; that is, don't report info about any item unless it's a member of one of those changelists. If <em>changelists</em> is empty (or altogether <code>NULL</code>), no changelist filtering occurs.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.5. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g803b08c81d5033e04c3d5dc234066488"></a><!-- doxytag: member="svn_client.h::svn_info_dup" ref="g803b08c81d5033e04c3d5dc234066488" args="(const svn_info_t *info, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__info__t.html">svn_info_t</a>* svn_info_dup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structsvn__info__t.html">svn_info_t</a> *&nbsp;</td>
<td class="paramname"> <em>info</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 a duplicate of <em>info</em>, allocated in <em>pool</em>.
<p>
No part of the new structure will be shared with <em>info</em>.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.3. </dd></dl>
</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>