LibreOffice
LibreOffice 5.2 SDK C/C++ API Reference
|
The directory class object provides a enumeration of DirectoryItems. More...
#include <file.hxx>
Public Member Functions | |
Directory (const ::rtl::OUString &strPath) | |
Constructor. More... | |
~Directory () | |
Destructor. More... | |
rtl::OUString | getURL () const |
Obtain the URL. More... | |
RC | open () |
Open a directory for enumerating its contents. More... | |
bool | isOpen () |
Query if directory is open. More... | |
RC | close () |
Close a directory. More... | |
RC | reset () |
Resets the directory item enumeration to the beginning. More... | |
RC | getNextItem (DirectoryItem &rItem, sal_uInt32 nHint=0) |
Retrieve the next item of a previously opened directory. More... | |
Static Public Member Functions | |
static RC | getVolumeInfo (const ::rtl::OUString &ustrDirectoryURL, VolumeInfo &rInfo) |
Retrieve information about a volume. More... | |
static RC | create (const ::rtl::OUString &ustrDirectoryURL, sal_uInt32 flags=osl_File_OpenFlag_Read|osl_File_OpenFlag_Write) |
Create a directory. More... | |
static RC | remove (const ::rtl::OUString &ustrDirectoryURL) |
Remove an empty directory. More... | |
static RC | createPath (const ::rtl::OUString &aDirectoryUrl, DirectoryCreationObserver *aDirectoryCreationObserver=NULL) |
Create a directory path. More... | |
![]() | |
static RC | getCanonicalName (const ::rtl::OUString &ustrRequestedURL, ::rtl::OUString &ustrValidURL) |
Determine a valid unused canonical name for a requested name. More... | |
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. More... | |
static RC | getSystemPathFromFileURL (const ::rtl::OUString &ustrFileURL, ::rtl::OUString &ustrSystemPath) |
Convert a file URL into a system dependent path. More... | |
static RC | getFileURLFromSystemPath (const ::rtl::OUString &ustrSystemPath, ::rtl::OUString &ustrFileURL) |
Convert a system dependent path into a file URL. More... | |
static RC | searchFileURL (const ::rtl::OUString &ustrFileName, const ::rtl::OUString &ustrSearchPath, ::rtl::OUString &ustrFileURL) |
Searche a full qualified system path or a file URL. More... | |
static RC | getTempDirURL (::rtl::OUString &ustrTempDirURL) |
Retrieves the file URL of the system's temporary directory path. More... | |
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. More... | |
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 class object provides a enumeration of DirectoryItems.
|
inline |
Constructor.
strPath | [in] The full qualified URL of the directory. Relative URLs are not allowed. |
|
inline |
Destructor.
|
inline |
Close a directory.
|
inlinestatic |
Create a directory.
ustrDirectoryURL | [in] Full qualified URL of the directory to create. |
flags | [in] Optional flags, see osl_createDirectoryWithFlags for details. This defaulted parameter is new since LibreOffice 4.3. |
|
inlinestatic |
Create a directory path.
The osl_createDirectoryPath function creates a specified directory path. All nonexisting sub directories will be created.
PLEASE NOTE: You cannot rely on getting the error code E_EXIST for existing directories. Programming against this error code is in general a strong indication of a wrong usage of osl_createDirectoryPath.
aDirectoryUrl | [in] The absolute file URL of the directory path to create. A relative file URL will not be accepted. |
aDirectoryCreationObserver | [in] Pointer to an instance of type DirectoryCreationObserver that will be informed about the creation of a directory. The value of this parameter may be NULL, in this case notifications will not be sent. |
|
inline |
Retrieve the next item of a previously opened directory.
Retrieves the next item of a previously opened directory.
rItem | [out] On success a valid DirectoryItem. |
nHint | [in] With this parameter the caller can tell the implementation that (s)he is going to call this function uHint times afterwards. This enables the implementation to get the information for more than one file and cache it until the next calls. |
|
inline |
|
inlinestatic |
Retrieve information about a volume.
Retrieves information about a volume. A volume can either be a mount point, a network resource or a drive depending on Operating System and File System.
ustrDirectoryURL | [in] Full qualified URL of the volume |
rInfo | [out] On success it receives information about the volume. |
|
inline |
|
inline |
Open a directory for enumerating its contents.
|
inlinestatic |
Remove an empty directory.
ustrDirectoryURL | [in] Full qualified URL of the directory. |
|
inline |
Resets the directory item enumeration to the beginning.