1 {{+bindTo:partials.standard_nacl_api}} 2 <h1>PPB_FileSystem Struct 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 </div> 10 <!--header--> 11 <div class="contents"> 12 <!-- doxytag: class="PPB_FileSystem" --><h2> 13 Data Fields</h2><table class="memberdecls"> 14 15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___file_system__1__0.html#a14946dd216cfe9cf786b2c1442588083">Create</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, <a class="el" href="group___enums.html#ga87b353f2ec8935c9c3294daff612c145">PP_FileSystemType</a> type)</td></tr> 16 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___file_system__1__0.html#a4d65860ba1d916f2488bab25e89d2dba">IsFileSystem</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr> 17 <tr><td class="memItemLeft" align="right" valign="top">int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___file_system__1__0.html#a9add9cdffaa742c8d19c33a73bca9e3a">Open</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> file_system, int64_t expected_size, struct <a class="el" href="struct_p_p___completion_callback.html">PP_CompletionCallback</a> callback)</td></tr> 18 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga87b353f2ec8935c9c3294daff612c145">PP_FileSystemType</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___file_system__1__0.html#a59a9fed00deae5bfbc9480184232ab68">GetType</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> file_system)</td></tr> 19 </table> 20 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2> 21 <div class="textblock"><p>The <code>PPB_FileSystem</code> struct identifies the file system type associated with a file. </p> 22 </div><hr /><h2>Field Documentation</h2> 23 <a class="anchor" id="a14946dd216cfe9cf786b2c1442588083"></a><!-- doxytag: member="PPB_FileSystem::Create" ref="a14946dd216cfe9cf786b2c1442588083" args=")(PP_Instance instance, PP_FileSystemType type)" --> 24 <div class="memitem"> 25 <div class="memproto"> 26 <table class="memname"> 27 <tr> 28 <td class="memname"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* <a class="el" href="struct_p_p_b___file_system__1__0.html#a14946dd216cfe9cf786b2c1442588083">PPB_FileSystem::Create</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, <a class="el" href="group___enums.html#ga87b353f2ec8935c9c3294daff612c145">PP_FileSystemType</a> type)</td> 29 </tr> 30 </table> 31 </div> 32 <div class="memdoc"> 33 <p><a class="el" href="struct_p_p_b___file_system__1__0.html#a14946dd216cfe9cf786b2c1442588083" title="Create() creates a file system object of the given type.">Create()</a> creates a file system object of the given type. </p> 34 <dl class="params"><dt><b>Parameters:</b></dt><dd> 35 <table class="params"> 36 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>A <code>PP_Instance</code> identifying the instance with the file. </td></tr> 37 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>A file system type as defined by <code>PP_FileSystemType</code> enum (except PP_FILESYSTEMTYPE_ISOLATED, which is currently not supported). </td></tr> 38 </table> 39 </dd> 40 </dl> 41 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Resource</code> corresponding to a file system if successful. </dd></dl> 42 </div> 43 </div> 44 <a class="anchor" id="a59a9fed00deae5bfbc9480184232ab68"></a><!-- doxytag: member="PPB_FileSystem::GetType" ref="a59a9fed00deae5bfbc9480184232ab68" args=")(PP_Resource file_system)" --> 45 <div class="memitem"> 46 <div class="memproto"> 47 <table class="memname"> 48 <tr> 49 <td class="memname"><a class="el" href="group___enums.html#ga87b353f2ec8935c9c3294daff612c145">PP_FileSystemType</a>(* <a class="el" href="struct_p_p_b___file_system__1__0.html#a59a9fed00deae5bfbc9480184232ab68">PPB_FileSystem::GetType</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> file_system)</td> 50 </tr> 51 </table> 52 </div> 53 <div class="memdoc"> 54 <p><a class="el" href="struct_p_p_b___file_system__1__0.html#a59a9fed00deae5bfbc9480184232ab68" title="GetType() returns the type of the provided file system.">GetType()</a> returns the type of the provided file system. </p> 55 <dl class="params"><dt><b>Parameters:</b></dt><dd> 56 <table class="params"> 57 <tr><td class="paramdir">[in]</td><td class="paramname">file_system</td><td>A <code>PP_Resource</code> corresponding to a file system.</td></tr> 58 </table> 59 </dd> 60 </dl> 61 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_FileSystemType</code> with the file system type if valid or <code>PP_FILESYSTEMTYPE_INVALID</code> if the provided resource is not a valid file system. It is valid to call this function even before <a class="el" href="struct_p_p_b___file_system__1__0.html#a9add9cdffaa742c8d19c33a73bca9e3a" title="Open() opens the file system.">Open()</a> completes. </dd></dl> 62 </div> 63 </div> 64 <a class="anchor" id="a4d65860ba1d916f2488bab25e89d2dba"></a><!-- doxytag: member="PPB_FileSystem::IsFileSystem" ref="a4d65860ba1d916f2488bab25e89d2dba" args=")(PP_Resource resource)" --> 65 <div class="memitem"> 66 <div class="memproto"> 67 <table class="memname"> 68 <tr> 69 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___file_system__1__0.html#a4d65860ba1d916f2488bab25e89d2dba">PPB_FileSystem::IsFileSystem</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td> 70 </tr> 71 </table> 72 </div> 73 <div class="memdoc"> 74 <p><a class="el" href="struct_p_p_b___file_system__1__0.html#a4d65860ba1d916f2488bab25e89d2dba" title="IsFileSystem() determines if the provided resource is a file system.">IsFileSystem()</a> determines if the provided resource is a file system. </p> 75 <dl class="params"><dt><b>Parameters:</b></dt><dd> 76 <table class="params"> 77 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a file system.</td></tr> 78 </table> 79 </dd> 80 </dl> 81 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if the resource is a <code>PPB_FileSystem</code>, <code>PP_FALSE</code> if the resource is invalid or some type other than <code>PPB_FileSystem</code>. </dd></dl> 82 </div> 83 </div> 84 <a class="anchor" id="a9add9cdffaa742c8d19c33a73bca9e3a"></a><!-- doxytag: member="PPB_FileSystem::Open" ref="a9add9cdffaa742c8d19c33a73bca9e3a" args=")(PP_Resource file_system, int64_t expected_size, struct PP_CompletionCallback callback)" --> 85 <div class="memitem"> 86 <div class="memproto"> 87 <table class="memname"> 88 <tr> 89 <td class="memname">int32_t(* <a class="el" href="struct_p_p_b___file_system__1__0.html#a9add9cdffaa742c8d19c33a73bca9e3a">PPB_FileSystem::Open</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> file_system, int64_t expected_size, struct <a class="el" href="struct_p_p___completion_callback.html">PP_CompletionCallback</a> callback)</td> 90 </tr> 91 </table> 92 </div> 93 <div class="memdoc"> 94 <p><a class="el" href="struct_p_p_b___file_system__1__0.html#a9add9cdffaa742c8d19c33a73bca9e3a" title="Open() opens the file system.">Open()</a> opens the file system. </p> 95 <p>A file system must be opened before running any other operation on it.</p> 96 <dl class="params"><dt><b>Parameters:</b></dt><dd> 97 <table class="params"> 98 <tr><td class="paramdir">[in]</td><td class="paramname">file_system</td><td>A <code>PP_Resource</code> corresponding to a file system.</td></tr> 99 <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> 100 <tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A <code><a class="el" href="struct_p_p___completion_callback.html" title="PP_CompletionCallback is a common mechanism for supporting potentially asynchronous calls in browser ...">PP_CompletionCallback</a></code> to be called upon completion of <a class="el" href="struct_p_p_b___file_system__1__0.html#a9add9cdffaa742c8d19c33a73bca9e3a" title="Open() opens the file system.">Open()</a>.</td></tr> 101 </table> 102 </dd> 103 </dl> 104 <dl class="return"><dt><b>Returns:</b></dt><dd>An int32_t containing an error code from <code><a class="el" href="pp__errors_8h.html" title="This file defines an enumeration of all PPAPI error codes.">pp_errors.h</a></code>. </dd></dl> 105 </div> 106 </div> 107 <hr />The documentation for this struct was generated from the following file:<ul> 108 <li><a class="el" href="ppb__file__system_8h.html">ppb_file_system.h</a></li> 109 </ul> 110 </div><!-- contents --> 111 </div> 112 {{/partials.standard_nacl_api}} 113