My Project
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. | |
![]() | |
static RC | getCanonicalName (const ::rtl::OUString &ustrRequestedURL,::rtl::OUString &ustrValidURL) |
Determine a valid unused canonical name for a requested name. | |
static RC | getAbsoluteFileURL (const ::rtl::OUString &ustrBaseDirectoryURL, const ::rtl::OUString &ustrRelativeFileURL,::rtl::OUString &ustrAbsoluteFileURL) |
Convert a path relative to a given directory into an full qualified file URL. | |
static RC | getSystemPathFromFileURL (const ::rtl::OUString &ustrFileURL,::rtl::OUString &ustrSystemPath) |
Convert a file URL into a system dependend path. | |
static RC | getFileURLFromSystemPath (const ::rtl::OUString &ustrSystemPath,::rtl::OUString &ustrFileURL) |
Convert a system dependend path into a file URL. | |
static RC | searchFileURL (const ::rtl::OUString &ustrFileName, const ::rtl::OUString &ustrSearchPath,::rtl::OUString &ustrFileURL) |
Searche a full qualified system path or a file URL. | |
static RC | getTempDirURL (::rtl::OUString &ustrTempDirURL) |
Retrieves the file URL of the system's temporary directory path. | |
static RC | createTempFile (::rtl::OUString *pustrDirectoryURL, oslFileHandle *pHandle,::rtl::OUString *pustrTempFileURL) |
Creates a temporary file in the directory provided by the caller or the directory returned by getTempDirURL. |
Friends | |
class | Directory |
Additional Inherited Members | |
![]() | |
enum | RC { E_None = osl_File_E_None, E_PERM = osl_File_E_PERM, E_NOENT = osl_File_E_NOENT, E_SRCH = osl_File_E_SRCH, E_INTR = osl_File_E_INTR, E_IO = osl_File_E_IO, E_NXIO = osl_File_E_NXIO, E_2BIG = osl_File_E_2BIG, E_NOEXEC = osl_File_E_NOEXEC, E_BADF = osl_File_E_BADF, E_CHILD = osl_File_E_CHILD, E_AGAIN = osl_File_E_AGAIN, E_NOMEM = osl_File_E_NOMEM, E_ACCES = osl_File_E_ACCES, E_FAULT = osl_File_E_FAULT, E_BUSY = osl_File_E_BUSY, E_EXIST = osl_File_E_EXIST, E_XDEV = osl_File_E_XDEV, E_NODEV = osl_File_E_NODEV, E_NOTDIR = osl_File_E_NOTDIR, E_ISDIR = osl_File_E_ISDIR, E_INVAL = osl_File_E_INVAL, E_NFILE = osl_File_E_NFILE, E_MFILE = osl_File_E_MFILE, E_NOTTY = osl_File_E_NOTTY, E_FBIG = osl_File_E_FBIG, E_NOSPC = osl_File_E_NOSPC, E_SPIPE = osl_File_E_SPIPE, E_ROFS = osl_File_E_ROFS, E_MLINK = osl_File_E_MLINK, E_PIPE = osl_File_E_PIPE, E_DOM = osl_File_E_DOM, E_RANGE = osl_File_E_RANGE, E_DEADLK = osl_File_E_DEADLK, E_NAMETOOLONG = osl_File_E_NAMETOOLONG, E_NOLCK = osl_File_E_NOLCK, E_NOSYS = osl_File_E_NOSYS, E_NOTEMPTY = osl_File_E_NOTEMPTY, E_LOOP = osl_File_E_LOOP, E_ILSEQ = osl_File_E_ILSEQ, E_NOLINK = osl_File_E_NOLINK, E_MULTIHOP = osl_File_E_MULTIHOP, E_USERS = osl_File_E_USERS, E_OVERFLOW = osl_File_E_OVERFLOW, E_NOTREADY = osl_File_E_NOTREADY, E_invalidError = osl_File_E_invalidError, E_TIMEDOUT = osl_File_E_TIMEDOUT, E_NETWORK = osl_File_E_NETWORK } |
The directory item class object provides access to file status information.
|
inline |
Constructor.
|
inline |
Copy constructor.
|
inline |
Destructor.
|
inlinestatic |
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(). |
|
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. |
|
inline |
Check for validity of this instance.
|
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 |
|
inline |
Assignment operator.
|
friend |