Public Member Functions
DirectoryEntry () | |
DirectoryEntry (PassRef, const PP_DirectoryEntry &data) | |
DirectoryEntry (const DirectoryEntry &other) | |
~DirectoryEntry () | |
DirectoryEntry & | operator= (const DirectoryEntry &other) |
bool | is_null () const |
FileRef | file_ref () const |
PP_FileType | file_type () const |
Detailed Description
The DirectoryEntry
class represents information about a directory entry.
Constructor & Destructor Documentation
Default constructor for creating an is_null() DirectoryEntry
object.
pp::DirectoryEntry::DirectoryEntry | ( | PassRef | , |
const PP_DirectoryEntry & | data | ||
) |
A constructor used when you have a PP_DirectoryEntry
which contains a FileRef
that has already been reference counted as a return value.
- Parameters:
[in] data A PP_DirectoryEntry
to be copied.
pp::DirectoryEntry::DirectoryEntry | ( | const DirectoryEntry & | other | ) |
A copy constructor for DirectoryEntry
.
This constructor increments a reference count of the FileRef
held by this DirectoryEntry.
- Parameters:
[in] other A pointer to a DirectoryEntry
.
A destructor that decrements a reference count of the FileRef
held by this DirectoryEntry
.
Member Function Documentation
FileRef pp::DirectoryEntry::file_ref | ( | ) | const [inline] |
This function returns the FileRef
held by this DirectoryEntry
.
- Returns:
- A
FileRef
of the file.
PP_FileType pp::DirectoryEntry::file_type | ( | ) | const [inline] |
This function returns the PP_FileType
of the file referenced by this DirectoryEntry
.
- Returns:
- A
PP_FileType
of the file.
bool pp::DirectoryEntry::is_null | ( | ) | const [inline] |
This function determines if this DirectoryEntry
is a null value.
- Returns:
- true if this
DirectoryEntry
is null, otherwise false.
DirectoryEntry& pp::DirectoryEntry::operator= | ( | const DirectoryEntry & | other | ) |
This function assigns one DirectoryEntry
object to this DirectoryEntry
object.
This function increases the reference count of the FileRef
of the other DirectoryEntry while decrementing the reference count of the FileRef of this DirectoryEntry.
- Parameters:
[in] other A pointer to a DirectoryEntry
.
- Returns:
- A new
DirectoryEntry
object.
The documentation for this class was generated from the following file: