Data Fields
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, int32_t make_directory_flags, 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) |
Detailed Description
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.
Field Documentation
PP_Resource(* PPB_FileRef::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.
- Parameters:
[in] resource A PP_Resource
corresponding to a file system.[in] path A path to the file. Must begin with a '/' character.
- Returns:
- A
PP_Resource
corresponding to a file reference if successful or 0 if the path is malformed.
int32_t(* PPB_FileRef::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.
- Parameters:
[in] file_ref A PP_Resource
corresponding to a file reference.[in] callback A PP_CompletionCallback
to be called upon completion of Delete().
- Returns:
- An int32_t containing an error code from
pp_errors.h
.
PP_FileSystemType(* PPB_FileRef::GetFileSystemType)(PP_Resource file_ref) |
GetFileSystemType() returns the type of the file system.
- Parameters:
[in] file_ref A PP_Resource
corresponding to a file reference.
- Returns:
- A
PP_FileSystemType
with the file system type if valid orPP_FILESYSTEMTYPE_INVALID
if the provided resource is not a valid file reference.
struct PP_Var(* PPB_FileRef::GetName)(PP_Resource file_ref) [read] |
GetName() returns the name of the file.
- Parameters:
[in] file_ref A PP_Resource
corresponding to a file reference.
PP_Resource(* PPB_FileRef::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.
- Parameters:
[in] file_ref A PP_Resource
corresponding to a file reference.
- Returns:
- A
PP_Resource
containing the parent directory of the file. This function fails if the file system type isPP_FileSystemType_External
.
struct PP_Var(* PPB_FileRef::GetPath)(PP_Resource file_ref) [read] |
PP_Bool(* PPB_FileRef::IsFileRef)(PP_Resource resource) |
IsFileRef() determines if the provided resource is a file reference.
- Parameters:
[in] resource A PP_Resource
corresponding to a file reference.
- Returns:
PP_TRUE
if the resource is aPPB_FileRef
,PP_FALSE
if the resource is invalid or some type other thanPPB_FileRef
.
int32_t(* PPB_FileRef::MakeDirectory)(PP_Resource directory_ref, int32_t make_directory_flags, struct PP_CompletionCallback callback) |
MakeDirectory() makes a new directory in the file system according to the given make_directory_flags
, which is a bit-mask of the PP_MakeDirectoryFlags
values.
It is not valid to make a directory in the external file system.
- Parameters:
[in] file_ref A PP_Resource
corresponding to a file reference.[in] make_directory_flags A bit-mask of the PP_MakeDirectoryFlags
values.[in] callback A PP_CompletionCallback
to be called upon completion of MakeDirectory().
- Returns:
- An int32_t containing an error code from
pp_errors.h
.
int32_t(* PPB_FileRef::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.
- Parameters:
[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().
- Returns:
- An int32_t containing an error code from
pp_errors.h
.
int32_t(* PPB_FileRef::ReadDirectoryEntries)(PP_Resource file_ref, struct PP_ArrayOutput output, struct PP_CompletionCallback callback) |
ReadDirectoryEntries() reads all entries in a directory.
- Parameters:
[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.
- Returns:
- An int32_t containing an error code from
pp_errors.h
.
int32_t(* PPB_FileRef::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.
- Parameters:
[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().
- Returns:
- An int32_t containing an error code from
pp_errors.h
.
int32_t(* PPB_FileRef::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.
- Parameters:
[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().
- Returns:
- An int32_t containing an error code from
pp_errors.h
.
The documentation for this struct was generated from the following file: