native_client_sdk/doc_generated/pepper_beta/cpp/classpp_1_1_directory_entry.html

{{+bindTo:partials.standard_nacl_api}}
<h1>pp::DirectoryEntry Class Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
  <div>
<!-- Generated by Doxygen 1.7.6.1 -->



</div>
<!--header-->
<div class="contents">
<!-- doxytag: class="pp::DirectoryEntry" -->
<p><a href="classpp_1_1_directory_entry-members.html">List of all members.</a></p>
<h2>
Public Member Functions</h2><table class="memberdecls">

<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_directory_entry.html#abd1a4a70ed1b922a232c78be62b1fe86">DirectoryEntry</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_directory_entry.html#aa8fe311e0fe27aee989f0a055ec2f2e4">DirectoryEntry</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, const PP_DirectoryEntry &amp;data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_directory_entry.html#af60a142d874f0bc2fed98bd8ae5b7cdc">DirectoryEntry</a> (const <a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a> &amp;other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_directory_entry.html#a3dd150a66dcb8e3b063f411d904dc356">~DirectoryEntry</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_directory_entry.html#a7e1b5b7376a2da0a4f736eb986092556">operator=</a> (const <a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a> &amp;other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_directory_entry.html#aea481437bc555e04429b4e7ec1005ef0">is_null</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_file_ref.html">FileRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_directory_entry.html#af6ff2a3c83a6f26455573bc07f15ec4d">file_ref</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PP_FileType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_directory_entry.html#a9c91f7dda30ef2f31ec9547f9fd9faaf">file_type</a> () const </td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code> class represents information about a directory entry. </p>
</div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abd1a4a70ed1b922a232c78be62b1fe86"></a><!-- doxytag: member="pp::DirectoryEntry::DirectoryEntry" ref="abd1a4a70ed1b922a232c78be62b1fe86" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_directory_entry.html#abd1a4a70ed1b922a232c78be62b1fe86">pp::DirectoryEntry::DirectoryEntry</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor for creating an <a class="el" href="classpp_1_1_directory_entry.html#aea481437bc555e04429b4e7ec1005ef0" title="This function determines if this DirectoryEntry is a null value.">is_null()</a> <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code> object. </p>
</div>
</div>
<a class="anchor" id="aa8fe311e0fe27aee989f0a055ec2f2e4"></a><!-- doxytag: member="pp::DirectoryEntry::DirectoryEntry" ref="aa8fe311e0fe27aee989f0a055ec2f2e4" args="(PassRef, const PP_DirectoryEntry &amp;data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_directory_entry.html#abd1a4a70ed1b922a232c78be62b1fe86">pp::DirectoryEntry::DirectoryEntry</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const PP_DirectoryEntry &amp;&#160;</td>
<td class="paramname"><em>data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor used when you have a <code>PP_DirectoryEntry</code> which contains a <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> that has already been reference counted as a return value. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A <code>PP_DirectoryEntry</code> to be copied. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af60a142d874f0bc2fed98bd8ae5b7cdc"></a><!-- doxytag: member="pp::DirectoryEntry::DirectoryEntry" ref="af60a142d874f0bc2fed98bd8ae5b7cdc" args="(const DirectoryEntry &amp;other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_directory_entry.html#abd1a4a70ed1b922a232c78be62b1fe86">pp::DirectoryEntry::DirectoryEntry</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A copy constructor for <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code>. </p>
<p>This constructor increments a reference count of the <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> held by this <a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A pointer to a <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3dd150a66dcb8e3b063f411d904dc356"></a><!-- doxytag: member="pp::DirectoryEntry::~DirectoryEntry" ref="a3dd150a66dcb8e3b063f411d904dc356" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_directory_entry.html#a3dd150a66dcb8e3b063f411d904dc356">pp::DirectoryEntry::~DirectoryEntry</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A destructor that decrements a reference count of the <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> held by this <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code>. </p>
</div>
</div>
<hr /><h2>Member Function Documentation</h2>
<a class="anchor" id="af6ff2a3c83a6f26455573bc07f15ec4d"></a><!-- doxytag: member="pp::DirectoryEntry::file_ref" ref="af6ff2a3c83a6f26455573bc07f15ec4d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_file_ref.html">FileRef</a> <a class="el" href="classpp_1_1_directory_entry.html#af6ff2a3c83a6f26455573bc07f15ec4d">pp::DirectoryEntry::file_ref</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> held by this <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> of the file. </dd></dl>
</div>
</div>
<a class="anchor" id="a9c91f7dda30ef2f31ec9547f9fd9faaf"></a><!-- doxytag: member="pp::DirectoryEntry::file_type" ref="a9c91f7dda30ef2f31ec9547f9fd9faaf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PP_FileType <a class="el" href="classpp_1_1_directory_entry.html#a9c91f7dda30ef2f31ec9547f9fd9faaf">pp::DirectoryEntry::file_type</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the <code>PP_FileType</code> of the file referenced by this <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_FileType</code> of the file. </dd></dl>
</div>
</div>
<a class="anchor" id="aea481437bc555e04429b4e7ec1005ef0"></a><!-- doxytag: member="pp::DirectoryEntry::is_null" ref="aea481437bc555e04429b4e7ec1005ef0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_directory_entry.html#aea481437bc555e04429b4e7ec1005ef0">pp::DirectoryEntry::is_null</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function determines if this <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code> is a null value. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code> is null, otherwise false. </dd></dl>
</div>
</div>
<a class="anchor" id="a7e1b5b7376a2da0a4f736eb986092556"></a><!-- doxytag: member="pp::DirectoryEntry::operator=" ref="a7e1b5b7376a2da0a4f736eb986092556" args="(const DirectoryEntry &amp;other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a>&amp; pp::DirectoryEntry::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function assigns one <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code> object to this <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code> object. </p>
<p>This function increases the reference count of the <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> of the other <a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a> while decrementing the reference count of the <a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a> of this <a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A pointer to a <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <code><a class="el" href="classpp_1_1_directory_entry.html" title="The DirectoryEntry class represents information about a directory entry.">DirectoryEntry</a></code> object. </dd></dl>
</div>
</div>
<hr />The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="directory__entry_8h.html">directory_entry.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}