src/native_client_sdk/doc_generated/pepper_stable/cpp/classpp_1_1_directory_entry.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::DirectoryEntry Class Reference</h1>
   3 <div id="doxygen-ref">
   4 {{- dummy div to appease doxygen -}}
   5   <div>
   6 <!-- Generated by Doxygen 1.7.6.1 -->
   7
   8
   9
  10 </div>
  11 <!--header-->
  12 <div class="contents">
  13 <!-- doxytag: class="pp::DirectoryEntry" -->
  14 <p><a href="classpp_1_1_directory_entry-members.html">List of all members.</a></p>
  15 <h2>
  16 Public Member Functions</h2><table class="memberdecls">
  17
  18 <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>
  19 <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>
  20 <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>
  21 <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>
  22 <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>
  23 <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>
  24 <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>
  25 <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>
  26 </table>
  27 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  28 <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>
  29 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  30 <a class="anchor" id="abd1a4a70ed1b922a232c78be62b1fe86"></a><!-- doxytag: member="pp::DirectoryEntry::DirectoryEntry" ref="abd1a4a70ed1b922a232c78be62b1fe86" args="()" -->
  31 <div class="memitem">
  32 <div class="memproto">
  33 <table class="memname">
  34 <tr>
  35 <td class="memname"><a class="el" href="classpp_1_1_directory_entry.html#abd1a4a70ed1b922a232c78be62b1fe86">pp::DirectoryEntry::DirectoryEntry</a> </td>
  36 <td>(</td>
  37 <td class="paramname"></td><td>)</td>
  38 <td></td>
  39 </tr>
  40 </table>
  41 </div>
  42 <div class="memdoc">
  43 <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>
  44 </div>
  45 </div>
  46 <a class="anchor" id="aa8fe311e0fe27aee989f0a055ec2f2e4"></a><!-- doxytag: member="pp::DirectoryEntry::DirectoryEntry" ref="aa8fe311e0fe27aee989f0a055ec2f2e4" args="(PassRef, const PP_DirectoryEntry &amp;data)" -->
  47 <div class="memitem">
  48 <div class="memproto">
  49 <table class="memname">
  50 <tr>
  51 <td class="memname"><a class="el" href="classpp_1_1_directory_entry.html#abd1a4a70ed1b922a232c78be62b1fe86">pp::DirectoryEntry::DirectoryEntry</a> </td>
  52 <td>(</td>
  53 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
  54 <td class="paramname">, </td>
  55 </tr>
  56 <tr>
  57 <td class="paramkey"></td>
  58 <td></td>
  59 <td class="paramtype">const PP_DirectoryEntry &amp;&#160;</td>
  60 <td class="paramname"><em>data</em>&#160;</td>
  61 </tr>
  62 <tr>
  63 <td></td>
  64 <td>)</td>
  65 <td></td><td></td>
  66 </tr>
  67 </table>
  68 </div>
  69 <div class="memdoc">
  70 <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>
  71 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  72 <table class="params">
  73 <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A <code>PP_DirectoryEntry</code> to be copied. </td></tr>
  74 </table>
  75 </dd>
  76 </dl>
  77 </div>
  78 </div>
  79 <a class="anchor" id="af60a142d874f0bc2fed98bd8ae5b7cdc"></a><!-- doxytag: member="pp::DirectoryEntry::DirectoryEntry" ref="af60a142d874f0bc2fed98bd8ae5b7cdc" args="(const DirectoryEntry &amp;other)" -->
  80 <div class="memitem">
  81 <div class="memproto">
  82 <table class="memname">
  83 <tr>
  84 <td class="memname"><a class="el" href="classpp_1_1_directory_entry.html#abd1a4a70ed1b922a232c78be62b1fe86">pp::DirectoryEntry::DirectoryEntry</a> </td>
  85 <td>(</td>
  86 <td class="paramtype">const <a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a> &amp;&#160;</td>
  87 <td class="paramname"><em>other</em></td><td>)</td>
  88 <td></td>
  89 </tr>
  90 </table>
  91 </div>
  92 <div class="memdoc">
  93 <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>
  94 <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>
  95 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  96 <table class="params">
  97 <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>
  98 </table>
  99 </dd>
 100 </dl>
 101 </div>
 102 </div>
 103 <a class="anchor" id="a3dd150a66dcb8e3b063f411d904dc356"></a><!-- doxytag: member="pp::DirectoryEntry::~DirectoryEntry" ref="a3dd150a66dcb8e3b063f411d904dc356" args="()" -->
 104 <div class="memitem">
 105 <div class="memproto">
 106 <table class="memname">
 107 <tr>
 108 <td class="memname"><a class="el" href="classpp_1_1_directory_entry.html#a3dd150a66dcb8e3b063f411d904dc356">pp::DirectoryEntry::~DirectoryEntry</a> </td>
 109 <td>(</td>
 110 <td class="paramname"></td><td>)</td>
 111 <td></td>
 112 </tr>
 113 </table>
 114 </div>
 115 <div class="memdoc">
 116 <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>
 117 </div>
 118 </div>
 119 <hr /><h2>Member Function Documentation</h2>
 120 <a class="anchor" id="af6ff2a3c83a6f26455573bc07f15ec4d"></a><!-- doxytag: member="pp::DirectoryEntry::file_ref" ref="af6ff2a3c83a6f26455573bc07f15ec4d" args="() const " -->
 121 <div class="memitem">
 122 <div class="memproto">
 123 <table class="memname">
 124 <tr>
 125 <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>
 126 <td>(</td>
 127 <td class="paramname"></td><td>)</td>
 128 <td> const<code> [inline]</code></td>
 129 </tr>
 130 </table>
 131 </div>
 132 <div class="memdoc">
 133 <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>
 134 <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>
 135 </div>
 136 </div>
 137 <a class="anchor" id="a9c91f7dda30ef2f31ec9547f9fd9faaf"></a><!-- doxytag: member="pp::DirectoryEntry::file_type" ref="a9c91f7dda30ef2f31ec9547f9fd9faaf" args="() const " -->
 138 <div class="memitem">
 139 <div class="memproto">
 140 <table class="memname">
 141 <tr>
 142 <td class="memname">PP_FileType <a class="el" href="classpp_1_1_directory_entry.html#a9c91f7dda30ef2f31ec9547f9fd9faaf">pp::DirectoryEntry::file_type</a> </td>
 143 <td>(</td>
 144 <td class="paramname"></td><td>)</td>
 145 <td> const<code> [inline]</code></td>
 146 </tr>
 147 </table>
 148 </div>
 149 <div class="memdoc">
 150 <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>
 151 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_FileType</code> of the file. </dd></dl>
 152 </div>
 153 </div>
 154 <a class="anchor" id="aea481437bc555e04429b4e7ec1005ef0"></a><!-- doxytag: member="pp::DirectoryEntry::is_null" ref="aea481437bc555e04429b4e7ec1005ef0" args="() const " -->
 155 <div class="memitem">
 156 <div class="memproto">
 157 <table class="memname">
 158 <tr>
 159 <td class="memname">bool <a class="el" href="classpp_1_1_directory_entry.html#aea481437bc555e04429b4e7ec1005ef0">pp::DirectoryEntry::is_null</a> </td>
 160 <td>(</td>
 161 <td class="paramname"></td><td>)</td>
 162 <td> const<code> [inline]</code></td>
 163 </tr>
 164 </table>
 165 </div>
 166 <div class="memdoc">
 167 <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>
 168 <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>
 169 </div>
 170 </div>
 171 <a class="anchor" id="a7e1b5b7376a2da0a4f736eb986092556"></a><!-- doxytag: member="pp::DirectoryEntry::operator=" ref="a7e1b5b7376a2da0a4f736eb986092556" args="(const DirectoryEntry &amp;other)" -->
 172 <div class="memitem">
 173 <div class="memproto">
 174 <table class="memname">
 175 <tr>
 176 <td class="memname"><a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a>&amp; pp::DirectoryEntry::operator= </td>
 177 <td>(</td>
 178 <td class="paramtype">const <a class="el" href="classpp_1_1_directory_entry.html">DirectoryEntry</a> &amp;&#160;</td>
 179 <td class="paramname"><em>other</em></td><td>)</td>
 180 <td></td>
 181 </tr>
 182 </table>
 183 </div>
 184 <div class="memdoc">
 185 <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>
 186 <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>
 187 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 188 <table class="params">
 189 <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>
 190 </table>
 191 </dd>
 192 </dl>
 193 <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>
 194 </div>
 195 </div>
 196 <hr />The documentation for this class was generated from the following file:<ul>
 197 <li><a class="el" href="directory__entry_8h.html">directory_entry.h</a></li>
 198 </ul>
 199 </div><!-- contents -->
 200 </div>
 201 {{/partials.standard_nacl_article}}