108 lines
7.4 KiB
HTML
108 lines
7.4 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_lock_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 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 class="current"><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 class="tabs">
|
|
<ul>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="functions.html"><span>Data Fields</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>svn_lock_t Struct Reference</h1><!-- doxytag: class="svn_lock_t" -->A lock object, for client & server to share.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="svn__types_8h-source.html">svn_types.h</a>></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"><a class="anchor" name="dd6c4e4ca7c1ea08de1add7ff959a6db"></a><!-- doxytag: member="svn_lock_t::path" ref="dd6c4e4ca7c1ea08de1add7ff959a6db" args="" -->
|
|
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__lock__t.html#dd6c4e4ca7c1ea08de1add7ff959a6db">path</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">the path this lock applies to <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4144de7089c750f1102f1130555b934f"></a><!-- doxytag: member="svn_lock_t::token" ref="4144de7089c750f1102f1130555b934f" args="" -->
|
|
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__lock__t.html#4144de7089c750f1102f1130555b934f">token</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">unique URI representing lock <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="725bc5b97485aa9450fe0b1afb5ea4a3"></a><!-- doxytag: member="svn_lock_t::owner" ref="725bc5b97485aa9450fe0b1afb5ea4a3" args="" -->
|
|
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__lock__t.html#725bc5b97485aa9450fe0b1afb5ea4a3">owner</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">the username which owns the lock <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1a28493e867d42a014819bb9b1283d1"></a><!-- doxytag: member="svn_lock_t::comment" ref="a1a28493e867d42a014819bb9b1283d1" args="" -->
|
|
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__lock__t.html#a1a28493e867d42a014819bb9b1283d1">comment</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">(optional) description of lock <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e39f3efb7f4ca75830350e01fa36fcc"></a><!-- doxytag: member="svn_lock_t::is_dav_comment" ref="4e39f3efb7f4ca75830350e01fa36fcc" args="" -->
|
|
<a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__lock__t.html#4e39f3efb7f4ca75830350e01fa36fcc">is_dav_comment</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">was comment made by generic DAV client? <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05f8d0490afcfe65df1e9fe5fece1392"></a><!-- doxytag: member="svn_lock_t::creation_date" ref="05f8d0490afcfe65df1e9fe5fece1392" args="" -->
|
|
apr_time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__lock__t.html#05f8d0490afcfe65df1e9fe5fece1392">creation_date</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">when lock was made <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__lock__t.html#d2588c3d3cf85c5cea3b5d3bac906545">expiration_date</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">(optional) when lock will expire; If value is 0, lock will never expire. <a href="#d2588c3d3cf85c5cea3b5d3bac906545"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
A lock object, for client & server to share.
|
|
<p>
|
|
A lock represents the exclusive right to add, delete, or modify a path. A lock is created in a repository, wholly controlled by the repository. A "lock-token" is the lock's UUID, and can be used to learn more about a lock's fields, and or/make use of the lock. Because a lock is immutable, a client is free to not only cache the lock-token, but the lock's fields too, for convenience.<p>
|
|
Note that the 'is_dav_comment' field is wholly ignored by every library except for mod_dav_svn. The field isn't even marshalled over the network to the client. Assuming lock structures are created with apr_pcalloc(), a default value of 0 is universally safe.<p>
|
|
<dl class="note" compact><dt><b>Note:</b></dt><dd>in the current implementation, only files are lockable.</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__types_8h-source.html#l00782">782</a> of file <a class="el" href="svn__types_8h-source.html">svn_types.h</a>.</p>
|
|
<hr><h2>Field Documentation</h2>
|
|
<a class="anchor" name="d2588c3d3cf85c5cea3b5d3bac906545"></a><!-- doxytag: member="svn_lock_t::expiration_date" ref="d2588c3d3cf85c5cea3b5d3bac906545" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">apr_time_t <a class="el" href="structsvn__lock__t.html#d2588c3d3cf85c5cea3b5d3bac906545">svn_lock_t::expiration_date</a> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
(optional) when lock will expire; If value is 0, lock will never expire.
|
|
<p>
|
|
|
|
<p>Definition at line <a class="el" href="svn__types_8h-source.html#l00790">790</a> of file <a class="el" href="svn__types_8h-source.html">svn_types.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__types_8h-source.html">svn_types.h</a></ul>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 24 16:18:30 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>
|