UDK 3.2.7 C/C++ API Reference
|
The directory item class object provides access to file status information. More...
#include <file.hxx>
Public Member Functions | |
DirectoryItem () | |
Constructor. | |
DirectoryItem (const DirectoryItem &rItem) | |
Copy constructor. | |
~DirectoryItem () | |
Destructor. | |
DirectoryItem & | operator= (const DirectoryItem &rItem) |
Assignment operator. | |
sal_Bool | is () |
Check for validity of this instance. | |
RC | getFileStatus (FileStatus &rStatus) |
Retrieve information about a single file or directory. | |
sal_Bool | isIdenticalTo (const DirectoryItem &pOther) |
Determine if a directory item point the the same underlying file. | |
Static Public Member Functions | |
static RC | get (const ::rtl::OUString &ustrFileURL, DirectoryItem &rItem) |
Retrieve a single directory item. | |
Friends | |
class | Directory |
The directory item class object provides access to file status information.
osl::DirectoryItem::DirectoryItem | ( | ) | [inline] |
Constructor.
osl::DirectoryItem::DirectoryItem | ( | const DirectoryItem & | rItem | ) | [inline] |
Copy constructor.
osl::DirectoryItem::~DirectoryItem | ( | ) | [inline] |
Destructor.
static RC osl::DirectoryItem::get | ( | const ::rtl::OUString & | ustrFileURL, |
DirectoryItem & | rItem | ||
) | [inline, static] |
Retrieve a single directory item.
Retrieves a single directory item. The returned handle has an initial refcount of 1. Due to performance issues it is not recommended to use this function while enumerating the contents of a directory. In this case use osl_getNextDirectoryItem() instead.
ustrFileURL | [in] An absolute file URL. |
rItem | [out] On success it receives a handle which can be used for subsequent calls to osl_getFileStatus(). The handle has to be released by a call to osl_releaseDirectoryItem(). |
RC osl::DirectoryItem::getFileStatus | ( | FileStatus & | rStatus | ) | [inline] |
Retrieve information about a single file or directory.
rStatus | [in|out] Reference to a class which receives the information of the file or directory represented by this directory item. |
sal_Bool osl::DirectoryItem::is | ( | ) | [inline] |
Check for validity of this instance.
sal_Bool osl::DirectoryItem::isIdenticalTo | ( | const DirectoryItem & | pOther | ) | [inline] |
Determine if a directory item point the the same underlying file.
The comparison is done first by URL, and then by resolving links to find the target, and finally by comparing inodes on unix.
[in] | pOther | A directory handle to compare with the underlying object's item |
DirectoryItem& osl::DirectoryItem::operator= | ( | const DirectoryItem & | rItem | ) | [inline] |
Assignment operator.
friend class Directory [friend] |