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

338 lines
21 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: Report interesting information about paths in the 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>Report interesting information about paths in the 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>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__Status.html#gc9abf15736b3c21c7c4f8c376d43e956">svn_client_status3</a> (<a class="el" href="svn__types_8h.html#f16427ed53d30f27da225c56552d2a89">svn_revnum_t</a> *result_rev, const char *path, const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *revision, <a class="el" href="group__svn__wc__status.html#gf68700e38ff4fd0a8a246e5c9290b14e">svn_wc_status_func2_t</a> status_func, void *status_baton, <a class="el" href="svn__types_8h.html#21dd8b080111fa6fb5d59156299f3a2c">svn_depth_t</a> depth, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> get_all, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> update, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> no_ignore, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> ignore_externals, 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">Given <em>path</em> to a working copy directory (or single file), call <em>status_func/status_baton</em> with a set of <code><a class="el" href="structsvn__wc__status__t.html" title="Same as svn_wc_status2_t, but without the svn_lock_t &#39;repos_lock&#39; field.">svn_wc_status_t</a></code> * structures which describe the status of <em>path</em>, and its children (recursing according to <em>depth</em>). <a href="#gc9abf15736b3c21c7c4f8c376d43e956"></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__Status.html#g248f69ba6e4356b593f285d8d14995fe">svn_client_status2</a> (<a class="el" href="svn__types_8h.html#f16427ed53d30f27da225c56552d2a89">svn_revnum_t</a> *result_rev, const char *path, const <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *revision, <a class="el" href="group__svn__wc__status.html#gf68700e38ff4fd0a8a246e5c9290b14e">svn_wc_status_func2_t</a> status_func, void *status_baton, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> recurse, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> get_all, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> update, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> no_ignore, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> ignore_externals, <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">Like <a class="el" href="group__Status.html#gc9abf15736b3c21c7c4f8c376d43e956" title="Given path to a working copy directory (or single file), call status_func/status_baton...">svn_client_status3()</a>, except with <em>changelists</em> passed as <code>NULL</code>, and with <em>recurse</em> instead of <em>depth</em>. <a href="#g248f69ba6e4356b593f285d8d14995fe"></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__Status.html#g52e822422ef964810712209c0d567b4f">svn_client_status</a> (<a class="el" href="svn__types_8h.html#f16427ed53d30f27da225c56552d2a89">svn_revnum_t</a> *result_rev, const char *path, <a class="el" href="structsvn__opt__revision__t.html">svn_opt_revision_t</a> *revision, <a class="el" href="group__svn__wc__status.html#gc19e1c47c044d86aaa9e3a0790efa17a">svn_wc_status_func_t</a> status_func, void *status_baton, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> recurse, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> get_all, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> update, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> no_ignore, <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__Status.html#g248f69ba6e4356b593f285d8d14995fe" title="Like svn_client_status3(), except with changelists passed as NULL, and with recurse...">svn_client_status2()</a>, but with <em>ignore_externals</em> always set to FALSE, taking the <code>svn_wc_status_func_t</code> type instead of the <code>svn_wc_status_func2_t</code> type for <em>status_func</em>, and requiring <em>*revision</em> to be non-const even though it is treated as constant. <a href="#g52e822422ef964810712209c0d567b4f"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g52e822422ef964810712209c0d567b4f"></a><!-- doxytag: member="svn_client.h::svn_client_status" ref="g52e822422ef964810712209c0d567b4f" args="(svn_revnum_t *result_rev, const char *path, svn_opt_revision_t *revision, svn_wc_status_func_t status_func, void *status_baton, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t update, svn_boolean_t no_ignore, 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_status </td>
<td>(</td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#f16427ed53d30f27da225c56552d2a89">svn_revnum_t</a> *&nbsp;</td>
<td class="paramname"> <em>result_rev</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="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__svn__wc__status.html#gc19e1c47c044d86aaa9e3a0790efa17a">svn_wc_status_func_t</a>&nbsp;</td>
<td class="paramname"> <em>status_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>status_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="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>get_all</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>update</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>no_ignore</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__Status.html#g248f69ba6e4356b593f285d8d14995fe" title="Like svn_client_status3(), except with changelists passed as NULL, and with recurse...">svn_client_status2()</a>, but with <em>ignore_externals</em> always set to FALSE, taking the <code>svn_wc_status_func_t</code> type instead of the <code>svn_wc_status_func2_t</code> type for <em>status_func</em>, and requiring <em>*revision</em> to be non-const even though it is treated as constant.
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000040">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.1 API. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g248f69ba6e4356b593f285d8d14995fe"></a><!-- doxytag: member="svn_client.h::svn_client_status2" ref="g248f69ba6e4356b593f285d8d14995fe" args="(svn_revnum_t *result_rev, const char *path, const svn_opt_revision_t *revision, svn_wc_status_func2_t status_func, void *status_baton, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t update, svn_boolean_t no_ignore, svn_boolean_t ignore_externals, 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_status2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#f16427ed53d30f27da225c56552d2a89">svn_revnum_t</a> *&nbsp;</td>
<td class="paramname"> <em>result_rev</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">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__svn__wc__status.html#gf68700e38ff4fd0a8a246e5c9290b14e">svn_wc_status_func2_t</a>&nbsp;</td>
<td class="paramname"> <em>status_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>status_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="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>get_all</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>update</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>no_ignore</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>ignore_externals</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>
Like <a class="el" href="group__Status.html#gc9abf15736b3c21c7c4f8c376d43e956" title="Given path to a working copy directory (or single file), call status_func/status_baton...">svn_client_status3()</a>, except with <em>changelists</em> passed as <code>NULL</code>, and with <em>recurse</em> instead of <em>depth</em>.
<p>
If <em>recurse</em> is TRUE, behave as if for <code>svn_depth_infinity</code>; else if <em>recurse</em> is FALSE, behave as if for <code>svn_depth_immediates</code>.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.2. </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000039">Deprecated:</a></b></dt><dd>Provided for backward compatibility with the 1.4 API. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc9abf15736b3c21c7c4f8c376d43e956"></a><!-- doxytag: member="svn_client.h::svn_client_status3" ref="gc9abf15736b3c21c7c4f8c376d43e956" args="(svn_revnum_t *result_rev, const char *path, const svn_opt_revision_t *revision, svn_wc_status_func2_t status_func, void *status_baton, svn_depth_t depth, svn_boolean_t get_all, svn_boolean_t update, svn_boolean_t no_ignore, svn_boolean_t ignore_externals, 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_status3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="svn__types_8h.html#f16427ed53d30f27da225c56552d2a89">svn_revnum_t</a> *&nbsp;</td>
<td class="paramname"> <em>result_rev</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">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__svn__wc__status.html#gf68700e38ff4fd0a8a246e5c9290b14e">svn_wc_status_func2_t</a>&nbsp;</td>
<td class="paramname"> <em>status_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>status_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"><a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a>&nbsp;</td>
<td class="paramname"> <em>get_all</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>update</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>no_ignore</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>ignore_externals</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>
Given <em>path</em> to a working copy directory (or single file), call <em>status_func/status_baton</em> with a set of <code><a class="el" href="structsvn__wc__status__t.html" title="Same as svn_wc_status2_t, but without the svn_lock_t &#39;repos_lock&#39; field.">svn_wc_status_t</a></code> * structures which describe the status of <em>path</em>, and its children (recursing according to <em>depth</em>).
<p>
<ul>
<li>If <em>get_all</em> is set, retrieve all entries; otherwise, retrieve only "interesting" entries (local mods and/or out of date).</li></ul>
<p>
<ul>
<li>If <em>update</em> is set, contact the repository and augment the status structures with information about out-of-dateness (with respect to <em>revision</em>). Also, if <em>result_rev</em> is not <code>NULL</code>, set <em>*result_rev</em> to the actual revision against which the working copy was compared (<em>*result_rev</em> is not meaningful unless <em>update</em> is set).</li></ul>
<p>
If <em>ignore_externals</em> is not set, then recurse into externals definitions (if any exist) after handling the main target. This calls the client notification function (in <em>ctx</em>) with the <code>svn_wc_notify_status_external</code> action before handling each externals definition, and with <code>svn_wc_notify_status_completed</code> after each.<p>
<em>changelists</em> is an array of <code>const char *</code> changelist names, used as a restrictive filter on items whose statuses are reported; that is, don't report status 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>
</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>