157 lines
8.8 KiB
HTML
157 lines
8.8 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 Locking 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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data 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> <u>S</u>earch for </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 Locking Functions<br>
|
|
<small>
|
|
[<a class="el" href="group__clnt__wc.html">Client working copy management</a>]</small>
|
|
</h1>Locking commands.
|
|
<a href="#_details">More...</a><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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__client__locking__funcs.html#gd679aa233e3e5151ba93fa756b9729f4">svn_client_lock</a> (const apr_array_header_t *targets, const char *comment, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> steal_lock, <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"> </td><td class="mdescRight">Lock <em>targets</em> in the repository. <a href="#gd679aa233e3e5151ba93fa756b9729f4"></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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__svn__client__locking__funcs.html#g003ddadf4634bae7f64d060d0f2835b2">svn_client_unlock</a> (const apr_array_header_t *targets, <a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> break_lock, <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"> </td><td class="mdescRight">Unlock <em>targets</em> in the repository. <a href="#g003ddadf4634bae7f64d060d0f2835b2"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Locking commands.
|
|
<p>
|
|
<hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="gd679aa233e3e5151ba93fa756b9729f4"></a><!-- doxytag: member="svn_client.h::svn_client_lock" ref="gd679aa233e3e5151ba93fa756b9729f4" args="(const apr_array_header_t *targets, const char *comment, svn_boolean_t steal_lock, 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_lock </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const apr_array_header_t * </td>
|
|
<td class="paramname"> <em>targets</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"> <em>comment</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> </td>
|
|
<td class="paramname"> <em>steal_lock</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> * </td>
|
|
<td class="paramname"> <em>ctx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">apr_pool_t * </td>
|
|
<td class="paramname"> <em>pool</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Lock <em>targets</em> in the repository.
|
|
<p>
|
|
<em>targets</em> is an array of <code>const char *</code> paths - either all working copy paths or URLs. All <em>targets</em> must be in the same repository.<p>
|
|
If a target is already locked in the repository, no lock will be acquired unless <em>steal_lock</em> is TRUE, in which case the locks are stolen. <em>comment</em>, if non-NULL, is an xml-escapable description stored with each lock in the repository. Each acquired lock will be stored in the working copy if the targets are WC paths.<p>
|
|
For each target <em>ctx->notify_func2/notify_baton2</em> will be used to indicate whether it was locked. An action of <code>svn_wc_notify_state_locked</code> means that the path was locked. If the path was not locked because it was out of date or there was already a lock in the repository, the notification function will be called with <code>svn_wc_notify_failed_lock</code>, and the error passed in the notification structure.<p>
|
|
Use <em>pool</em> for temporary allocations.<p>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.2. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="g003ddadf4634bae7f64d060d0f2835b2"></a><!-- doxytag: member="svn_client.h::svn_client_unlock" ref="g003ddadf4634bae7f64d060d0f2835b2" args="(const apr_array_header_t *targets, svn_boolean_t break_lock, 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_unlock </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const apr_array_header_t * </td>
|
|
<td class="paramname"> <em>targets</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> </td>
|
|
<td class="paramname"> <em>break_lock</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> * </td>
|
|
<td class="paramname"> <em>ctx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">apr_pool_t * </td>
|
|
<td class="paramname"> <em>pool</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Unlock <em>targets</em> in the repository.
|
|
<p>
|
|
<em>targets</em> is an array of <code>const char *</code> paths - either all working copy paths or all URLs. All <em>targets</em> must be in the same repository.<p>
|
|
If the targets are WC paths, and <em>break_lock</em> is FALSE, the working copy must contain a locks for each target. If this is not the case, or the working copy lock doesn't match the lock token in the repository, an error will be signaled.<p>
|
|
If the targets are URLs, the locks may be broken even if <em>break_lock</em> is FALSE, but only if the lock owner is the same as the authenticated user.<p>
|
|
If <em>break_lock</em> is TRUE, the locks will be broken in the repository. In both cases, the locks, if any, will be removed from the working copy if the targets are WC paths.<p>
|
|
The notification functions in <em>ctx</em> will be called for each target. If the target was successfully unlocked, <code>svn_wc_notify_unlocked</code> will be used. Else, if the error is directly related to unlocking the path (see <code>SVN_ERR_IS_UNLOCK_ERROR</code>), <code>svn_wc_notify_failed_unlock</code> will be used and the error will be passed in the notification structure.<p>
|
|
Use <em>pool</em> for temporary allocations.<p>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>New in 1.2. </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
|
|
<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>
|