src/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_file_system.html

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::FileSystem 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::FileSystem" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
  14 Inheritance diagram for pp::FileSystem:</div>
  15 <div class="dyncontent">
  16 <div class="center"><img src="classpp_1_1_file_system__inherit__graph.png" border="0" usemap="#pp_1_1_file_system_inherit__map" alt="Inheritance graph" /></div>
  17 <map name="pp_1_1_file_system_inherit__map" id="pp_1_1_file_system_inherit__map">
  18 <area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="11,5,115,32"></area></map>
  19 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  20 <p><a href="classpp_1_1_file_system-members.html">List of all members.</a></p>
  21 <h2>
  22 Public Member Functions</h2><table class="memberdecls">
  23
  24 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_file_system.html#aaa3cca58df52c4a3c4daaf0e615a1168">FileSystem</a> ()</td></tr>
  25 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_file_system.html#a4d56e93917775b192558b55fe682acfd">FileSystem</a> (const <a class="el" href="classpp_1_1_file_system.html">FileSystem</a> &amp;other)</td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_file_system.html#a33ddc6114cd25d48727c300dccc8754d">FileSystem</a> (const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;resource)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_file_system.html#af97b2860b7e99d2283cf556b4ca78c48">FileSystem</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, PP_Resource resource)</td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_file_system.html#a8e73239f076ec5897d49b2bf530fdfdc">FileSystem</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance, PP_FileSystemType type)</td></tr>
  29 <tr><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_file_system.html#ae1ca78fc88c2e2a507e9ab71d9352d54">Open</a> (int64_t expected_size, const <a class="el" href="classpp_1_1_completion_callback.html">CompletionCallback</a> &amp;cc)</td></tr>
  30 </table><h2>
  31 Static Public Member Functions</h2><table class="memberdecls">
  32 <tr><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_file_system.html#ae48a32b67e78b1e2125270ec68fab29d">IsFileSystem</a> (const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;resource)</td></tr>
  33 </table>
  34 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  35 <div class="textblock"><p>The <code><a class="el" href="classpp_1_1_file_system.html" title="The FileSystem class identifies the file system type associated with a file.">FileSystem</a></code> class identifies the file system type associated with a file. </p>
  36 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  37 <a class="anchor" id="aaa3cca58df52c4a3c4daaf0e615a1168"></a><!-- doxytag: member="pp::FileSystem::FileSystem" ref="aaa3cca58df52c4a3c4daaf0e615a1168" args="()" -->
  38 <div class="memitem">
  39 <div class="memproto">
  40 <table class="memname">
  41 <tr>
  42 <td class="memname"><a class="el" href="classpp_1_1_file_system.html#aaa3cca58df52c4a3c4daaf0e615a1168">pp::FileSystem::FileSystem</a> </td>
  43 <td>(</td>
  44 <td class="paramname"></td><td>)</td>
  45 <td></td>
  46 </tr>
  47 </table>
  48 </div>
  49 <div class="memdoc">
  50 <p>Constructs an <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9" title="This functions determines if this resource is invalid or uninitialized.">is_null()</a> filesystem resource. </p>
  51 <p>If you use this constructor, you will have to assign it to a "real" <a class="el" href="classpp_1_1_file_system.html" title="The FileSystem class identifies the file system type associated with a file.">FileSystem</a> object before you can use it. </p>
  52 </div>
  53 </div>
  54 <a class="anchor" id="a4d56e93917775b192558b55fe682acfd"></a><!-- doxytag: member="pp::FileSystem::FileSystem" ref="a4d56e93917775b192558b55fe682acfd" args="(const FileSystem &amp;other)" -->
  55 <div class="memitem">
  56 <div class="memproto">
  57 <table class="memname">
  58 <tr>
  59 <td class="memname"><a class="el" href="classpp_1_1_file_system.html#aaa3cca58df52c4a3c4daaf0e615a1168">pp::FileSystem::FileSystem</a> </td>
  60 <td>(</td>
  61 <td class="paramtype">const <a class="el" href="classpp_1_1_file_system.html">FileSystem</a> &amp;&#160;</td>
  62 <td class="paramname"><em>other</em></td><td>)</td>
  63 <td></td>
  64 </tr>
  65 </table>
  66 </div>
  67 <div class="memdoc">
  68 <p>The copy constructor for <code><a class="el" href="classpp_1_1_file_system.html" title="The FileSystem class identifies the file system type associated with a file.">FileSystem</a></code>. </p>
  69 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  70 <table class="params">
  71 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A reference to a <code><a class="el" href="classpp_1_1_file_system.html" title="The FileSystem class identifies the file system type associated with a file.">FileSystem</a></code>. </td></tr>
  72 </table>
  73 </dd>
  74 </dl>
  75 </div>
  76 </div>
  77 <a class="anchor" id="a33ddc6114cd25d48727c300dccc8754d"></a><!-- doxytag: member="pp::FileSystem::FileSystem" ref="a33ddc6114cd25d48727c300dccc8754d" args="(const Resource &amp;resource)" -->
  78 <div class="memitem">
  79 <div class="memproto">
  80 <table class="memname">
  81 <tr>
  82 <td class="memname"><a class="el" href="classpp_1_1_file_system.html#aaa3cca58df52c4a3c4daaf0e615a1168">pp::FileSystem::FileSystem</a> </td>
  83 <td>(</td>
  84 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
  85 <td class="paramname"><em>resource</em></td><td>)</td>
  86 <td><code> [explicit]</code></td>
  87 </tr>
  88 </table>
  89 </div>
  90 <div class="memdoc">
  91 <p>Constructs a <code><a class="el" href="classpp_1_1_file_system.html" title="The FileSystem class identifies the file system type associated with a file.">FileSystem</a></code> from a <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code>. </p>
  92 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  93 <table class="params">
  94 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code> containing a file system. </td></tr>
  95 </table>
  96 </dd>
  97 </dl>
  98 </div>
  99 </div>
 100 <a class="anchor" id="af97b2860b7e99d2283cf556b4ca78c48"></a><!-- doxytag: member="pp::FileSystem::FileSystem" ref="af97b2860b7e99d2283cf556b4ca78c48" args="(PassRef, PP_Resource resource)" -->
 101 <div class="memitem">
 102 <div class="memproto">
 103 <table class="memname">
 104 <tr>
 105 <td class="memname"><a class="el" href="classpp_1_1_file_system.html#aaa3cca58df52c4a3c4daaf0e615a1168">pp::FileSystem::FileSystem</a> </td>
 106 <td>(</td>
 107 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
 108 <td class="paramname">, </td>
 109 </tr>
 110 <tr>
 111 <td class="paramkey"></td>
 112 <td></td>
 113 <td class="paramtype">PP_Resource&#160;</td>
 114 <td class="paramname"><em>resource</em>&#160;</td>
 115 </tr>
 116 <tr>
 117 <td></td>
 118 <td>)</td>
 119 <td></td><td></td>
 120 </tr>
 121 </table>
 122 </div>
 123 <div class="memdoc">
 124 <p>A constructor used when you have received a PP_Resource as a return value that has already been reference counted. </p>
 125 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 126 <table class="params">
 127 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A PP_Resource corresponding to a PPB_FileSystem. </td></tr>
 128 </table>
 129 </dd>
 130 </dl>
 131 </div>
 132 </div>
 133 <a class="anchor" id="a8e73239f076ec5897d49b2bf530fdfdc"></a><!-- doxytag: member="pp::FileSystem::FileSystem" ref="a8e73239f076ec5897d49b2bf530fdfdc" args="(const InstanceHandle &amp;instance, PP_FileSystemType type)" -->
 134 <div class="memitem">
 135 <div class="memproto">
 136 <table class="memname">
 137 <tr>
 138 <td class="memname"><a class="el" href="classpp_1_1_file_system.html#aaa3cca58df52c4a3c4daaf0e615a1168">pp::FileSystem::FileSystem</a> </td>
 139 <td>(</td>
 140 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
 141 <td class="paramname"><em>instance</em>, </td>
 142 </tr>
 143 <tr>
 144 <td class="paramkey"></td>
 145 <td></td>
 146 <td class="paramtype">PP_FileSystemType&#160;</td>
 147 <td class="paramname"><em>type</em>&#160;</td>
 148 </tr>
 149 <tr>
 150 <td></td>
 151 <td>)</td>
 152 <td></td><td></td>
 153 </tr>
 154 </table>
 155 </div>
 156 <div class="memdoc">
 157 <p>This constructor creates a file system object of the given type. </p>
 158 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 159 <table class="params">
 160 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance with which this resource will be associated.</td></tr>
 161 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>A file system type as defined by <code>PP_FileSystemType</code> enum. </td></tr>
 162 </table>
 163 </dd>
 164 </dl>
 165 </div>
 166 </div>
 167 <hr /><h2>Member Function Documentation</h2>
 168 <a class="anchor" id="ae48a32b67e78b1e2125270ec68fab29d"></a><!-- doxytag: member="pp::FileSystem::IsFileSystem" ref="ae48a32b67e78b1e2125270ec68fab29d" args="(const Resource &amp;resource)" -->
 169 <div class="memitem">
 170 <div class="memproto">
 171 <table class="memname">
 172 <tr>
 173 <td class="memname">static bool <a class="el" href="classpp_1_1_file_system.html#ae48a32b67e78b1e2125270ec68fab29d">pp::FileSystem::IsFileSystem</a> </td>
 174 <td>(</td>
 175 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
 176 <td class="paramname"><em>resource</em></td><td>)</td>
 177 <td><code> [static]</code></td>
 178 </tr>
 179 </table>
 180 </div>
 181 <div class="memdoc">
 182 <p>Checks whether a <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code> is a file system, to test whether it is appropriate for use with the <code><a class="el" href="classpp_1_1_file_system.html" title="The FileSystem class identifies the file system type associated with a file.">FileSystem</a></code> constructor. </p>
 183 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 184 <table class="params">
 185 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code> to test.</td></tr>
 186 </table>
 187 </dd>
 188 </dl>
 189 <dl class="return"><dt><b>Returns:</b></dt><dd>True if <code>resource</code> is a file system. </dd></dl>
 190 </div>
 191 </div>
 192 <a class="anchor" id="ae1ca78fc88c2e2a507e9ab71d9352d54"></a><!-- doxytag: member="pp::FileSystem::Open" ref="ae1ca78fc88c2e2a507e9ab71d9352d54" args="(int64_t expected_size, const CompletionCallback &amp;cc)" -->
 193 <div class="memitem">
 194 <div class="memproto">
 195 <table class="memname">
 196 <tr>
 197 <td class="memname">int32_t <a class="el" href="classpp_1_1_file_system.html#ae1ca78fc88c2e2a507e9ab71d9352d54">pp::FileSystem::Open</a> </td>
 198 <td>(</td>
 199 <td class="paramtype">int64_t&#160;</td>
 200 <td class="paramname"><em>expected_size</em>, </td>
 201 </tr>
 202 <tr>
 203 <td class="paramkey"></td>
 204 <td></td>
 205 <td class="paramtype">const <a class="el" href="classpp_1_1_completion_callback.html">CompletionCallback</a> &amp;&#160;</td>
 206 <td class="paramname"><em>cc</em>&#160;</td>
 207 </tr>
 208 <tr>
 209 <td></td>
 210 <td>)</td>
 211 <td></td><td></td>
 212 </tr>
 213 </table>
 214 </div>
 215 <div class="memdoc">
 216 <p><a class="el" href="classpp_1_1_file_system.html#ae1ca78fc88c2e2a507e9ab71d9352d54" title="Open() opens the file system.">Open()</a> opens the file system. </p>
 217 <p>A file system must be opened before running any other operation on it.</p>
 218 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 219 <table class="params">
 220 <tr><td class="paramdir">[in]</td><td class="paramname">expected_size</td><td>The expected size of the file system. Note that this does not request quota; to do that, you must either invoke requestQuota from JavaScript: <a href="http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-requesting-quota">http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-requesting-quota</a> or set the unlimitedStorage permission for Chrome Web Store apps: <a href="http://code.google.com/chrome/extensions/manifest.html#permissions">http://code.google.com/chrome/extensions/manifest.html#permissions</a></td></tr>
 221 <tr><td class="paramdir">[in]</td><td class="paramname">cc</td><td>A <code>PP_CompletionCallback</code> to be called upon completion of <a class="el" href="classpp_1_1_file_system.html#ae1ca78fc88c2e2a507e9ab71d9352d54" title="Open() opens the file system.">Open()</a>.</td></tr>
 222 </table>
 223 </dd>
 224 </dl>
 225 <dl class="return"><dt><b>Returns:</b></dt><dd>An int32_t containing an error code from <code>pp_errors.h</code>. </dd></dl>
 226 </div>
 227 </div>
 228 <hr />The documentation for this class was generated from the following file:<ul>
 229 <li><a class="el" href="file__system_8h.html">file_system.h</a></li>
 230 </ul>
 231 </div><!-- contents -->
 232 </div>
 233 {{/partials.standard_nacl_api}}