<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>SvnCpp: svn::Status Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.8 --> <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="namespaces.html"><span>Namespaces</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> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacesvn.html">svn</a>::<a class="el" href="classsvn_1_1Status.html">Status</a> </div> </div> <div class="contents"> <h1>svn::Status Class Reference</h1><!-- doxytag: class="svn::Status" --><code>#include <<a class="el" href="status_8hpp-source.html">status.hpp</a>></code> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#53218299060391bddbb5428ffc531b17">Status</a> (const char *path=0, const svn_wc_status2_t *status=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#8ab1c57d5b73ecdc098d87df62434861">Status</a> (const <a class="el" href="classsvn_1_1Status.html">Status</a> &src)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#bb498f7d3b98c6c9bcd4bc0404c83a6f">~Status</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#67e611c4fe25c659c5d837398fe6d757">path</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classsvn_1_1Entry.html">Entry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#d228fd8825e3c858a7acd84b1222d241">entry</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">svn_wc_status_kind </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#d85c4d3337a1f2f47f4e64707f34e827">textStatus</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">svn_wc_status_kind </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#21fc3db522636079b847006d40accd9c">propStatus</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#17b431909bdbf0f1b6b70d8e6f5af702">isVersioned</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#1c1037e4317ed98cdd71e5741b002495">isCopied</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#5340ba79732baed7eaccb02c66e5ea69">isSwitched</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">svn_wc_status_kind </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#cfa02cfc3e04932690f63a3d6304a029">reposTextStatus</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">svn_wc_status_kind </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#5d098a5f96c3a6353a7741abaff2684b">reposPropStatus</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#6fa909df3e4d8a0e01bc9f2167c228b2">isLocked</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#cc58142362160b17ce85628bb537415e">isRepLock</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#9417394d69303fd32a979ebc95831206">lockToken</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#69eae88aa869789b810f5a1e47636567">lockOwner</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#b67f67006604dcb8a6cdf7fa9a332401">lockComment</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">apr_time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#8f0b85528e9ede96b931206ea58cdd1a">lockCreationDate</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsvn_1_1Status.html">Status</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#091cc16887d4a41527812beb844d0cfd">operator=</a> (const <a class="el" href="classsvn_1_1Status.html">Status</a> &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvn_1_1Status.html#84d1f7bc46dc22bdf07345c039120d32">isSet</a> () const </td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Subversion status API.<p> <dl class="see" compact><dt><b>See also:</b></dt><dd>svn_wc.hpp </dd></dl> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="53218299060391bddbb5428ffc531b17"></a><!-- doxytag: member="svn::Status::Status" ref="53218299060391bddbb5428ffc531b17" args="(const char *path=0, const svn_wc_status2_t *status=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">svn::Status::Status </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>path</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const svn_wc_status2_t * </td> <td class="paramname"> <em>status</em> = <code>0</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> default constructor<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td></td></tr> <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td></td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="8ab1c57d5b73ecdc098d87df62434861"></a><!-- doxytag: member="svn::Status::Status" ref="8ab1c57d5b73ecdc098d87df62434861" args="(const Status &src)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">svn::Status::Status </td> <td>(</td> <td class="paramtype">const <a class="el" href="classsvn_1_1Status.html">Status</a> & </td> <td class="paramname"> <em>src</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> copy constructor </div> </div><p> <a class="anchor" name="bb498f7d3b98c6c9bcd4bc0404c83a6f"></a><!-- doxytag: member="svn::Status::~Status" ref="bb498f7d3b98c6c9bcd4bc0404c83a6f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">svn::Status::~Status </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> destructor </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="d228fd8825e3c858a7acd84b1222d241"></a><!-- doxytag: member="svn::Status::entry" ref="d228fd8825e3c858a7acd84b1222d241" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classsvn_1_1Entry.html">Entry</a> svn::Status::entry </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>entry for this path </dd></dl> <dl compact><dt><b>Return values:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>entry.isValid</em> </td><td>() = false item is not versioned </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="1c1037e4317ed98cdd71e5741b002495"></a><!-- doxytag: member="svn::Status::isCopied" ref="1c1037e4317ed98cdd71e5741b002495" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool svn::Status::isCopied </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Return values:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>TRUE</em> </td><td>if copied </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="6fa909df3e4d8a0e01bc9f2167c228b2"></a><!-- doxytag: member="svn::Status::isLocked" ref="6fa909df3e4d8a0e01bc9f2167c228b2" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool svn::Status::isLocked </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if locked </dd></dl> </div> </div><p> <a class="anchor" name="cc58142362160b17ce85628bb537415e"></a><!-- doxytag: member="svn::Status::isRepLock" ref="cc58142362160b17ce85628bb537415e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool svn::Status::isRepLock </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if has repository lock (not local) </dd></dl> </div> </div><p> <a class="anchor" name="84d1f7bc46dc22bdf07345c039120d32"></a><!-- doxytag: member="svn::Status::isSet" ref="84d1f7bc46dc22bdf07345c039120d32" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool svn::Status::isSet </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> check whether the instance contains real data or nothing if it has constructed with the default constructor<p> <dl class="note" compact><dt><b>Note:</b></dt><dd>This is the successor of <em>isset</em> which had to be removed since there was a name conflict with system headers on some systems (see issue 676) </dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.12 </dd></dl> </div> </div><p> <a class="anchor" name="5340ba79732baed7eaccb02c66e5ea69"></a><!-- doxytag: member="svn::Status::isSwitched" ref="5340ba79732baed7eaccb02c66e5ea69" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool svn::Status::isSwitched </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Return values:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>TRUE</em> </td><td>if switched </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="17b431909bdbf0f1b6b70d8e6f5af702"></a><!-- doxytag: member="svn::Status::isVersioned" ref="17b431909bdbf0f1b6b70d8e6f5af702" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool svn::Status::isVersioned </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Return values:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>TRUE</em> </td><td>if under version control </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="b67f67006604dcb8a6cdf7fa9a332401"></a><!-- doxytag: member="svn::Status::lockComment" ref="b67f67006604dcb8a6cdf7fa9a332401" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* svn::Status::lockComment </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>comment lock, null or no comment </dd></dl> </div> </div><p> <a class="anchor" name="8f0b85528e9ede96b931206ea58cdd1a"></a><!-- doxytag: member="svn::Status::lockCreationDate" ref="8f0b85528e9ede96b931206ea58cdd1a" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_time_t svn::Status::lockCreationDate </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>lock creation date or 0 if not locked </dd></dl> </div> </div><p> <a class="anchor" name="69eae88aa869789b810f5a1e47636567"></a><!-- doxytag: member="svn::Status::lockOwner" ref="69eae88aa869789b810f5a1e47636567" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* svn::Status::lockOwner </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>lock owner or null if not locked </dd></dl> </div> </div><p> <a class="anchor" name="9417394d69303fd32a979ebc95831206"></a><!-- doxytag: member="svn::Status::lockToken" ref="9417394d69303fd32a979ebc95831206" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* svn::Status::lockToken </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>lock token or null if not locked </dd></dl> </div> </div><p> <a class="anchor" name="091cc16887d4a41527812beb844d0cfd"></a><!-- doxytag: member="svn::Status::operator=" ref="091cc16887d4a41527812beb844d0cfd" args="(const Status &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classsvn_1_1Status.html">Status</a>& svn::Status::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classsvn_1_1Status.html">Status</a> & </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> assignment operator </div> </div><p> <a class="anchor" name="67e611c4fe25c659c5d837398fe6d757"></a><!-- doxytag: member="svn::Status::path" ref="67e611c4fe25c659c5d837398fe6d757" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* svn::Status::path </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>path of status entry </dd></dl> </div> </div><p> <a class="anchor" name="21fc3db522636079b847006d40accd9c"></a><!-- doxytag: member="svn::Status::propStatus" ref="21fc3db522636079b847006d40accd9c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">svn_wc_status_kind svn::Status::propStatus </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>file status property enum of the "property" component. </dd></dl> </div> </div><p> <a class="anchor" name="5d098a5f96c3a6353a7741abaff2684b"></a><!-- doxytag: member="svn::Status::reposPropStatus" ref="5d098a5f96c3a6353a7741abaff2684b" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">svn_wc_status_kind svn::Status::reposPropStatus </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the entry's prop status in the repository </dd></dl> </div> </div><p> <a class="anchor" name="cfa02cfc3e04932690f63a3d6304a029"></a><!-- doxytag: member="svn::Status::reposTextStatus" ref="cfa02cfc3e04932690f63a3d6304a029" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">svn_wc_status_kind svn::Status::reposTextStatus </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the entry's text status in the repository </dd></dl> </div> </div><p> <a class="anchor" name="d85c4d3337a1f2f47f4e64707f34e827"></a><!-- doxytag: member="svn::Status::textStatus" ref="d85c4d3337a1f2f47f4e64707f34e827" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">svn_wc_status_kind svn::Status::textStatus </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>file status property enum of the "textual" component. </dd></dl> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="status_8hpp-source.html">status.hpp</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 20 09:20:18 2009 for SvnCpp by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> </body> </html>