OLD | NEW |
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 * Use of this source code is governed by a BSD-style license that can be | 2 * Use of this source code is governed by a BSD-style license that can be |
3 * found in the LICENSE file. | 3 * found in the LICENSE file. |
4 */ | 4 */ |
5 | 5 |
6 /* From ppb_file_system.idl modified Mon Mar 19 11:36:09 2012. */ | 6 /* From ppb_file_system.idl modified Mon May 21 15:19:32 2012. */ |
7 | 7 |
8 #ifndef PPAPI_C_PPB_FILE_SYSTEM_H_ | 8 #ifndef PPAPI_C_PPB_FILE_SYSTEM_H_ |
9 #define PPAPI_C_PPB_FILE_SYSTEM_H_ | 9 #define PPAPI_C_PPB_FILE_SYSTEM_H_ |
10 | 10 |
11 #include "ppapi/c/pp_bool.h" | 11 #include "ppapi/c/pp_bool.h" |
12 #include "ppapi/c/pp_completion_callback.h" | 12 #include "ppapi/c/pp_completion_callback.h" |
13 #include "ppapi/c/pp_file_info.h" | 13 #include "ppapi/c/pp_file_info.h" |
14 #include "ppapi/c/pp_instance.h" | 14 #include "ppapi/c/pp_instance.h" |
15 #include "ppapi/c/pp_macros.h" | 15 #include "ppapi/c/pp_macros.h" |
16 #include "ppapi/c/pp_resource.h" | 16 #include "ppapi/c/pp_resource.h" |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
55 * <code>PPB_FileSystem</code>, <code>PP_FALSE</code> if the resource is | 55 * <code>PPB_FileSystem</code>, <code>PP_FALSE</code> if the resource is |
56 * invalid or some type other than <code>PPB_FileSystem</code>. | 56 * invalid or some type other than <code>PPB_FileSystem</code>. |
57 */ | 57 */ |
58 PP_Bool (*IsFileSystem)(PP_Resource resource); | 58 PP_Bool (*IsFileSystem)(PP_Resource resource); |
59 /** | 59 /** |
60 * Open() opens the file system. A file system must be opened before running | 60 * Open() opens the file system. A file system must be opened before running |
61 * any other operation on it. | 61 * any other operation on it. |
62 * | 62 * |
63 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file | 63 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file |
64 * system. | 64 * system. |
65 * @param[in] expected_size The expected size of the file system. | 65 * |
| 66 * @param[in] expected_size The expected size of the file system. Note that |
| 67 * this does not request quota; to do that, you must either invoke |
| 68 * requestQuota from JavaScript: |
| 69 |
| 70 |
| 71 * http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-requesting-quo
ta |
| 72 * or set the unlimitedStorage permission for Chrome Web Store apps: |
| 73 * http://code.google.com/chrome/extensions/manifest.html#permissions |
| 74 * |
66 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon | 75 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon |
67 * completion of Open(). | 76 * completion of Open(). |
68 * | 77 * |
69 * @return An int32_t containing an error code from <code>pp_errors.h</code>. | 78 * @return An int32_t containing an error code from <code>pp_errors.h</code>. |
70 */ | 79 */ |
71 int32_t (*Open)(PP_Resource file_system, | 80 int32_t (*Open)(PP_Resource file_system, |
72 int64_t expected_size, | 81 int64_t expected_size, |
73 struct PP_CompletionCallback callback); | 82 struct PP_CompletionCallback callback); |
74 /** | 83 /** |
75 * GetType() returns the type of the provided file system. | 84 * GetType() returns the type of the provided file system. |
76 * | 85 * |
77 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file | 86 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file |
78 * system. | 87 * system. |
79 * | 88 * |
80 * @return A <code>PP_FileSystemType</code> with the file system type if | 89 * @return A <code>PP_FileSystemType</code> with the file system type if |
81 * valid or <code>PP_FILESYSTEMTYPE_INVALID</code> if the provided resource | 90 * valid or <code>PP_FILESYSTEMTYPE_INVALID</code> if the provided resource |
82 * is not a valid file system. It is valid to call this function even before | 91 * is not a valid file system. It is valid to call this function even before |
83 * Open() completes. | 92 * Open() completes. |
84 */ | 93 */ |
85 PP_FileSystemType (*GetType)(PP_Resource file_system); | 94 PP_FileSystemType (*GetType)(PP_Resource file_system); |
86 }; | 95 }; |
87 | 96 |
88 typedef struct PPB_FileSystem_1_0 PPB_FileSystem; | 97 typedef struct PPB_FileSystem_1_0 PPB_FileSystem; |
89 /** | 98 /** |
90 * @} | 99 * @} |
91 */ | 100 */ |
92 | 101 |
93 #endif /* PPAPI_C_PPB_FILE_SYSTEM_H_ */ | 102 #endif /* PPAPI_C_PPB_FILE_SYSTEM_H_ */ |
94 | 103 |
OLD | NEW |