Inheritance diagram for pp::FileSystem:
Public Member Functions
FileSystem () | |
FileSystem (const FileSystem &other) | |
FileSystem (const Resource &resource) | |
FileSystem (PassRef, PP_Resource resource) | |
FileSystem (const InstanceHandle &instance, PP_FileSystemType type) | |
int32_t | Open (int64_t expected_size, const CompletionCallback &cc) |
Static Public Member Functions
static bool | IsFileSystem (const Resource &resource) |
Detailed Description
The FileSystem
class identifies the file system type associated with a file.
Constructor & Destructor Documentation
Constructs an is_null() filesystem resource.
If you use this constructor, you will have to assign it to a "real" FileSystem object before you can use it.
pp::FileSystem::FileSystem | ( | const FileSystem & | other | ) |
The copy constructor for FileSystem
.
- Parameters:
[in] other A reference to a FileSystem
.
pp::FileSystem::FileSystem | ( | const Resource & | resource | ) | [explicit] |
Constructs a FileSystem
from a Resource
.
- Parameters:
[in] resource A Resource
containing a file system.
pp::FileSystem::FileSystem | ( | PassRef | , |
PP_Resource | resource | ||
) |
A constructor used when you have received a PP_Resource as a return value that has already been reference counted.
- Parameters:
[in] resource A PP_Resource corresponding to a PPB_FileSystem.
pp::FileSystem::FileSystem | ( | const InstanceHandle & | instance, |
PP_FileSystemType | type | ||
) |
This constructor creates a file system object of the given type.
- Parameters:
[in] instance The instance with which this resource will be associated. [in] type A file system type as defined by PP_FileSystemType
enum.
Member Function Documentation
static bool pp::FileSystem::IsFileSystem | ( | const Resource & | resource | ) | [static] |
Checks whether a Resource
is a file system, to test whether it is appropriate for use with the FileSystem
constructor.
- Parameters:
[in] resource A Resource
to test.
- Returns:
- True if
resource
is a file system.
int32_t pp::FileSystem::Open | ( | int64_t | expected_size, |
const CompletionCallback & | cc | ||
) |
Open() opens the file system.
A file system must be opened before running any other operation on it.
- Parameters:
[in] expected_size The 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] cc A 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 class was generated from the following file: