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

330 lines
20 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: svn_wc_notify_t Struct Reference</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 class="current"><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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>svn_wc_notify_t Struct Reference<br>
<small>
[<a class="el" href="group__svn__wc__notifications.html">Notification callback handling</a>]</small>
</h1><!-- doxytag: class="svn_wc_notify_t" -->Structure used in the <code>svn_wc_notify_func2_t</code> function.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#18a0e75c7335d63a4bc4dd901d27ec86">path</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Path, either absolute or relative to the current working directory (i.e., not relative to an anchor). <a href="#18a0e75c7335d63a4bc4dd901d27ec86"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__svn__wc__notifications.html#g816dd065327746637bb9af6322959dfb">svn_wc_notify_action_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#5eeeb245fd816ee3fa332ab8d2907b40">action</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action that describes what happened to <code>path</code>. <a href="#5eeeb245fd816ee3fa332ab8d2907b40"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="svn__types_8h.html#c3ca125707a8ca1289c73236b5ce7f9a">svn_node_kind_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#e9dbc0b2970104bb5372078ba1d08061">kind</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Node kind of <code>path</code>. <a href="#e9dbc0b2970104bb5372078ba1d08061"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#69a2156ef45b8cda7b4c39f4d8d0762a">mime_type</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If non-NULL, indicates the mime-type of <code>path</code>. <a href="#69a2156ef45b8cda7b4c39f4d8d0762a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structsvn__lock__t.html">svn_lock_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#5af3db77b756e7ddecc43537dc3438f7">lock</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Points to the lock structure received from the repository when <code>action</code> is <code>svn_wc_notify_locked</code>. <a href="#5af3db77b756e7ddecc43537dc3438f7"></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="structsvn__wc__notify__t.html#a7ced822d6fb2f3a082c63face95edf9">err</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Points to an error describing the reason for the failure when <code>action</code> is <code>svn_wc_notify_failed_lock</code> or <code>svn_wc_notify_failed_unlock</code>. <a href="#a7ced822d6fb2f3a082c63face95edf9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__svn__wc__notifications.html#g86188fa68605f8c57b7849857b1e6543">svn_wc_notify_state_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#59c80f6af33747c20fd1eff5f5d406a0">content_state</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The type of notification that is occurring about node content. <a href="#59c80f6af33747c20fd1eff5f5d406a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__svn__wc__notifications.html#g86188fa68605f8c57b7849857b1e6543">svn_wc_notify_state_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#b3bd85966e914028b28a937a135269c7">prop_state</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The type of notification that is occurring about node properties. <a href="#b3bd85966e914028b28a937a135269c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__svn__wc__notifications.html#gc65b99bf7baf711fdc2d4afb8ddcaad9">svn_wc_notify_lock_state_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#80ef3fec5428439c665a59d0daf4ff40">lock_state</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reflects the addition or removal of a lock token in the working copy. <a href="#80ef3fec5428439c665a59d0daf4ff40"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="svn__types_8h.html#f16427ed53d30f27da225c56552d2a89">svn_revnum_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#f456bf5fba4e718fe5e4049fca29c350">revision</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When <code>action</code> is <code>svn_wc_notify_update_completed</code>, target revision of the update, or <code>SVN_INVALID_REVNUM</code> if not available; when <code>action</code> is <code>svn_wc_notify_blame_revision</code>, processed revision. <a href="#f456bf5fba4e718fe5e4049fca29c350"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#cf9a8253bb63669e55a5e23bcc5580e9">changelist_name</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When <code>action</code> is <code>svn_wc_notify_changelist_add</code> or name. <a href="#cf9a8253bb63669e55a5e23bcc5580e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__merge__range__t.html">svn_merge_range_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__wc__notify__t.html#c21132410ecfff9772e0e2e5161645fa">merge_range</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When <code>action</code> is <code>svn_wc_notify_merge_begin</code>, and both the left and right sides of the merge are from the same URL. <a href="#c21132410ecfff9772e0e2e5161645fa"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Structure used in the <code>svn_wc_notify_func2_t</code> function.
<p>
<code>kind</code>, <code>content_state</code>, <code>prop_state</code> and <code>lock_state</code> are from after <code>action</code>, not before.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>If <code>action</code> is <code>svn_wc_notify_update</code>, then <code>path</code> has already been installed, so it is legitimate for an implementation of <code>svn_wc_notify_func2_t</code> to examine <code>path</code> in the working copy.<p>
The purpose of the <code>kind</code>, <code>mime_type</code>, <code>content_state</code>, and <code>prop_state</code> fields is to provide "for free" information that an implementation is likely to want, and which it would otherwise be forced to deduce via expensive operations such as reading entries and properties. However, if the caller does not have this information, it will simply pass the corresponding `*_unknown' values, and it is up to the implementation how to handle that (i.e., whether to attempt deduction, or just to punt and give a less informative notification).<p>
Callers of notification functions should use <a class="el" href="group__svn__wc__notifications.html#gffde9d9cea32a599c610a36bfcdb0496" title="Allocate an svn_wc_notify_t structure in pool, initialize and return it.">svn_wc_create_notify()</a> to create structures of this type to allow for extensibility.</dd></dl>
<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__wc_8h-source.html#l00872">872</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="18a0e75c7335d63a4bc4dd901d27ec86"></a><!-- doxytag: member="svn_wc_notify_t::path" ref="18a0e75c7335d63a4bc4dd901d27ec86" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structsvn__wc__notify__t.html#18a0e75c7335d63a4bc4dd901d27ec86">svn_wc_notify_t::path</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Path, either absolute or relative to the current working directory (i.e., not relative to an anchor).
<p>
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00875">875</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5eeeb245fd816ee3fa332ab8d2907b40"></a><!-- doxytag: member="svn_wc_notify_t::action" ref="5eeeb245fd816ee3fa332ab8d2907b40" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__svn__wc__notifications.html#g816dd065327746637bb9af6322959dfb">svn_wc_notify_action_t</a> <a class="el" href="structsvn__wc__notify__t.html#5eeeb245fd816ee3fa332ab8d2907b40">svn_wc_notify_t::action</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Action that describes what happened to <code>path</code>.
<p>
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00877">877</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="e9dbc0b2970104bb5372078ba1d08061"></a><!-- doxytag: member="svn_wc_notify_t::kind" ref="e9dbc0b2970104bb5372078ba1d08061" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="svn__types_8h.html#c3ca125707a8ca1289c73236b5ce7f9a">svn_node_kind_t</a> <a class="el" href="structsvn__wc__notify__t.html#e9dbc0b2970104bb5372078ba1d08061">svn_wc_notify_t::kind</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Node kind of <code>path</code>.
<p>
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00879">879</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="69a2156ef45b8cda7b4c39f4d8d0762a"></a><!-- doxytag: member="svn_wc_notify_t::mime_type" ref="69a2156ef45b8cda7b4c39f4d8d0762a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structsvn__wc__notify__t.html#69a2156ef45b8cda7b4c39f4d8d0762a">svn_wc_notify_t::mime_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If non-NULL, indicates the mime-type of <code>path</code>.
<p>
It is always <code>NULL</code> for directories.
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00882">882</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5af3db77b756e7ddecc43537dc3438f7"></a><!-- doxytag: member="svn_wc_notify_t::lock" ref="5af3db77b756e7ddecc43537dc3438f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structsvn__lock__t.html">svn_lock_t</a>* <a class="el" href="structsvn__wc__notify__t.html#5af3db77b756e7ddecc43537dc3438f7">svn_wc_notify_t::lock</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Points to the lock structure received from the repository when <code>action</code> is <code>svn_wc_notify_locked</code>.
<p>
For other actions, it is <code>NULL</code>.
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00886">886</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a7ced822d6fb2f3a082c63face95edf9"></a><!-- doxytag: member="svn_wc_notify_t::err" ref="a7ced822d6fb2f3a082c63face95edf9" args="" -->
<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>* <a class="el" href="structsvn__wc__notify__t.html#a7ced822d6fb2f3a082c63face95edf9">svn_wc_notify_t::err</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Points to an error describing the reason for the failure when <code>action</code> is <code>svn_wc_notify_failed_lock</code> or <code>svn_wc_notify_failed_unlock</code>.
<p>
Is <code>NULL</code> otherwise.
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00890">890</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="59c80f6af33747c20fd1eff5f5d406a0"></a><!-- doxytag: member="svn_wc_notify_t::content_state" ref="59c80f6af33747c20fd1eff5f5d406a0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__svn__wc__notifications.html#g86188fa68605f8c57b7849857b1e6543">svn_wc_notify_state_t</a> <a class="el" href="structsvn__wc__notify__t.html#59c80f6af33747c20fd1eff5f5d406a0">svn_wc_notify_t::content_state</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The type of notification that is occurring about node content.
<p>
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00892">892</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3bd85966e914028b28a937a135269c7"></a><!-- doxytag: member="svn_wc_notify_t::prop_state" ref="b3bd85966e914028b28a937a135269c7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__svn__wc__notifications.html#g86188fa68605f8c57b7849857b1e6543">svn_wc_notify_state_t</a> <a class="el" href="structsvn__wc__notify__t.html#b3bd85966e914028b28a937a135269c7">svn_wc_notify_t::prop_state</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The type of notification that is occurring about node properties.
<p>
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00894">894</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="80ef3fec5428439c665a59d0daf4ff40"></a><!-- doxytag: member="svn_wc_notify_t::lock_state" ref="80ef3fec5428439c665a59d0daf4ff40" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__svn__wc__notifications.html#gc65b99bf7baf711fdc2d4afb8ddcaad9">svn_wc_notify_lock_state_t</a> <a class="el" href="structsvn__wc__notify__t.html#80ef3fec5428439c665a59d0daf4ff40">svn_wc_notify_t::lock_state</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reflects the addition or removal of a lock token in the working copy.
<p>
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00896">896</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f456bf5fba4e718fe5e4049fca29c350"></a><!-- doxytag: member="svn_wc_notify_t::revision" ref="f456bf5fba4e718fe5e4049fca29c350" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="svn__types_8h.html#f16427ed53d30f27da225c56552d2a89">svn_revnum_t</a> <a class="el" href="structsvn__wc__notify__t.html#f456bf5fba4e718fe5e4049fca29c350">svn_wc_notify_t::revision</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When <code>action</code> is <code>svn_wc_notify_update_completed</code>, target revision of the update, or <code>SVN_INVALID_REVNUM</code> if not available; when <code>action</code> is <code>svn_wc_notify_blame_revision</code>, processed revision.
<p>
In all other cases, it is <code>SVN_INVALID_REVNUM</code>.
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00901">901</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="cf9a8253bb63669e55a5e23bcc5580e9"></a><!-- doxytag: member="svn_wc_notify_t::changelist_name" ref="cf9a8253bb63669e55a5e23bcc5580e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structsvn__wc__notify__t.html#cf9a8253bb63669e55a5e23bcc5580e9">svn_wc_notify_t::changelist_name</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When <code>action</code> is <code>svn_wc_notify_changelist_add</code> or name.
<p>
In all other cases, it is <code>NULL</code>.
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00904">904</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c21132410ecfff9772e0e2e5161645fa"></a><!-- doxytag: member="svn_wc_notify_t::merge_range" ref="c21132410ecfff9772e0e2e5161645fa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__merge__range__t.html">svn_merge_range_t</a>* <a class="el" href="structsvn__wc__notify__t.html#c21132410ecfff9772e0e2e5161645fa">svn_wc_notify_t::merge_range</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When <code>action</code> is <code>svn_wc_notify_merge_begin</code>, and both the left and right sides of the merge are from the same URL.
<p>
In all other cases, it is <code>NULL</code>.
<p>Definition at line <a class="el" href="svn__wc_8h-source.html#l00908">908</a> of file <a class="el" href="svn__wc_8h-source.html">svn_wc.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="svn__wc_8h-source.html">svn_wc.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 24 16:18:31 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>