{{+bindTo:partials.standard_nacl_api}}

PPB_FileSystem Struct Reference

{{- dummy div to appease doxygen -}}

Data Fields

PP_Resource(* Create )(PP_Instance instance, PP_FileSystemType type)
PP_Bool(* IsFileSystem )(PP_Resource resource)
int32_t(* Open )(PP_Resource file_system, int64_t expected_size, struct PP_CompletionCallback callback)
PP_FileSystemType(* GetType )(PP_Resource file_system)

Detailed Description

The PPB_FileSystem struct identifies the file system type associated with a file.

Field Documentation

PP_Resource(* PPB_FileSystem::Create)(PP_Instance instance, PP_FileSystemType type)

Create() creates a file system object of the given type.

Parameters:
[in]instanceA PP_Instance identifying the instance with the file.
[in]typeA file system type as defined by PP_FileSystemType enum (except PP_FILESYSTEMTYPE_ISOLATED, which is currently not supported).
Returns:
A PP_Resource corresponding to a file system if successful.
PP_FileSystemType(* PPB_FileSystem::GetType)(PP_Resource file_system)

GetType() returns the type of the provided file system.

Parameters:
[in]file_systemA PP_Resource corresponding to a file system.
Returns:
A PP_FileSystemType with the file system type if valid or PP_FILESYSTEMTYPE_INVALID if the provided resource is not a valid file system. It is valid to call this function even before Open() completes.
PP_Bool(* PPB_FileSystem::IsFileSystem)(PP_Resource resource)

IsFileSystem() determines if the provided resource is a file system.

Parameters:
[in]resourceA PP_Resource corresponding to a file system.
Returns:
PP_TRUE if the resource is a PPB_FileSystem, PP_FALSE if the resource is invalid or some type other than PPB_FileSystem.
int32_t(* PPB_FileSystem::Open)(PP_Resource file_system, int64_t expected_size, struct PP_CompletionCallback callback)

Open() opens the file system.

A file system must be opened before running any other operation on it.

Parameters:
[in]file_systemA PP_Resource corresponding to a file system.
[in]expected_sizeThe expected size of the file system. Note that this does not request quota; to do that, you must either invoke requestQuota from JavaScript: http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-requesting-quota or set the unlimitedStorage permission for Chrome Web Store apps: http://code.google.com/chrome/extensions/manifest.html#permissions
[in]callbackA PP_CompletionCallback to be called upon completion of Open().
Returns:
An int32_t containing an error code from pp_errors.h.
The documentation for this struct was generated from the following file:
{{/partials.standard_nacl_api}}