Pepper_31_C_interfaces
|
#include <ppb_file_ref.h>
Public Attributes | |
PP_Resource(* | Create )(PP_Resource file_system, const char *path) |
PP_Bool(* | IsFileRef )(PP_Resource resource) |
PP_FileSystemType(* | GetFileSystemType )(PP_Resource file_ref) |
struct PP_Var(* | GetName )(PP_Resource file_ref) |
struct PP_Var(* | GetPath )(PP_Resource file_ref) |
PP_Resource(* | GetParent )(PP_Resource file_ref) |
int32_t(* | MakeDirectory )(PP_Resource directory_ref, PP_Bool make_ancestors, struct PP_CompletionCallback callback) |
int32_t(* | Touch )(PP_Resource file_ref, PP_Time last_access_time, PP_Time last_modified_time, struct PP_CompletionCallback callback) |
int32_t(* | Delete )(PP_Resource file_ref, struct PP_CompletionCallback callback) |
int32_t(* | Rename )(PP_Resource file_ref, PP_Resource new_file_ref, struct PP_CompletionCallback callback) |
int32_t(* | Query )(PP_Resource file_ref, struct PP_FileInfo *info, struct PP_CompletionCallback callback) |
int32_t(* | ReadDirectoryEntries )(PP_Resource file_ref, struct PP_ArrayOutput output, struct PP_CompletionCallback callback) |
The PPB_FileRef
struct represents a "weak pointer" to a file in a file system. This struct contains a PP_FileSystemType
identifier and a file path string.
Definition at line 41 of file ppb_file_ref.h.
PP_Resource(* PPB_FileRef_1_1::Create)(PP_Resource file_system, const char *path) |
Create() creates a weak pointer to a file in the given file system. File paths are POSIX style.
[in] | resource | A PP_Resource corresponding to a file system. |
[in] | path | A path to the file. Must begin with a '/' character. |
PP_Resource
corresponding to a file reference if successful or 0 if the path is malformed. Definition at line 53 of file ppb_file_ref.h.
int32_t(* PPB_FileRef_1_1::Delete)(PP_Resource file_ref, struct PP_CompletionCallback callback) |
Delete() deletes a file or directory. If file_ref
refers to a directory, then the directory must be empty. It is an error to delete a file or directory that is in use. It is not valid to delete a file in the external file system.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
[in] | callback | A PP_CompletionCallback to be called upon completion of Delete(). |
pp_errors.h
. Definition at line 162 of file ppb_file_ref.h.
PP_FileSystemType(* PPB_FileRef_1_1::GetFileSystemType)(PP_Resource file_ref) |
GetFileSystemType() returns the type of the file system.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
PP_FileSystemType
with the file system type if valid or PP_FILESYSTEMTYPE_INVALID
if the provided resource is not a valid file reference. Definition at line 75 of file ppb_file_ref.h.
struct PP_Var(* PPB_FileRef_1_1::GetName)(PP_Resource file_ref) |
GetName() returns the name of the file.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
PP_Var
containing the name of the file. The value returned by this function does not include any path components (such as the name of the parent directory, for example). It is just the name of the file. Use GetPath() to get the full file path. Definition at line 87 of file ppb_file_ref.h.
PP_Resource(* PPB_FileRef_1_1::GetParent)(PP_Resource file_ref) |
GetParent() returns the parent directory of this file. If file_ref
points to the root of the filesystem, then the root is returned.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
PP_Resource
containing the parent directory of the file. This function fails if the file system type is PP_FileSystemType_External
. Definition at line 111 of file ppb_file_ref.h.
struct PP_Var(* PPB_FileRef_1_1::GetPath)(PP_Resource file_ref) |
GetPath() returns the absolute path of the file.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
PP_Var
containing the absolute path of the file. This function fails if the file system type is PP_FileSystemType_External
. Definition at line 98 of file ppb_file_ref.h.
PP_Bool(* PPB_FileRef_1_1::IsFileRef)(PP_Resource resource) |
IsFileRef() determines if the provided resource is a file reference.
[in] | resource | A PP_Resource corresponding to a file reference. |
PP_TRUE
if the resource is a PPB_FileRef
, PP_FALSE
if the resource is invalid or some type other than PPB_FileRef
. Definition at line 64 of file ppb_file_ref.h.
int32_t(* PPB_FileRef_1_1::MakeDirectory)(PP_Resource directory_ref, PP_Bool make_ancestors, struct PP_CompletionCallback callback) |
MakeDirectory() makes a new directory in the file system as well as any parent directories if the make_ancestors
argument is PP_TRUE
. It is not valid to make a directory in the external file system.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
[in] | make_ancestors | A PP_Bool set to PP_TRUE to make ancestor directories or PP_FALSE if ancestor directories are not needed. |
pp_errors.h
. Succeeds if the directory already exists. Fails if ancestor directories do not exist and make_ancestors
was passed as PP_FALSE
. Definition at line 129 of file ppb_file_ref.h.
int32_t(* PPB_FileRef_1_1::Query)(PP_Resource file_ref, struct PP_FileInfo *info, struct PP_CompletionCallback callback) |
Query() queries info about a file or directory. You must have access to read this file or directory if it exists in the external filesystem.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
[out] | info | A pointer to a PP_FileInfo which will be populated with information about the file or directory. |
[in] | callback | A PP_CompletionCallback to be called upon completion of Query(). |
pp_errors.h
. Definition at line 195 of file ppb_file_ref.h.
int32_t(* PPB_FileRef_1_1::ReadDirectoryEntries)(PP_Resource file_ref, struct PP_ArrayOutput output, struct PP_CompletionCallback callback) |
ReadDirectoryEntries() reads all entries in a directory.
[in] | file_ref | A PP_Resource corresponding to a directory reference. |
[in] | output | An output array which will receive PP_DirectoryEntry objects on success. |
[in] | callback | A PP_CompletionCallback to run on completion. |
pp_errors.h
. Definition at line 210 of file ppb_file_ref.h.
int32_t(* PPB_FileRef_1_1::Rename)(PP_Resource file_ref, PP_Resource new_file_ref, struct PP_CompletionCallback callback) |
Rename() renames a file or directory. Arguments file_ref
and new_file_ref
must both refer to files in the same file system. It is an error to rename a file or directory that is in use. It is not valid to rename a file in the external file system.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
[in] | new_file_ref | A PP_Resource corresponding to a new file reference. |
[in] | callback | A PP_CompletionCallback to be called upon completion of Rename(). |
pp_errors.h
. Definition at line 179 of file ppb_file_ref.h.
int32_t(* PPB_FileRef_1_1::Touch)(PP_Resource file_ref, PP_Time last_access_time, PP_Time last_modified_time, struct PP_CompletionCallback callback) |
Touch() Updates time stamps for a file. You must have write access to the file if it exists in the external filesystem.
[in] | file_ref | A PP_Resource corresponding to a file reference. |
[in] | last_access_time | The last time the file was accessed. |
[in] | last_modified_time | The last time the file was modified. |
[in] | callback | A PP_CompletionCallback to be called upon completion of Touch(). |
pp_errors.h
. Definition at line 145 of file ppb_file_ref.h.