Overview | Namespace | Class | Index | Help |
rtl_uString * | ustrSystemPath, |
rtl_uString * * | pustrCompacted, |
sal_uInt32 | uMaxWidth, |
oslCalcTextWidthFunc | pCalcWidth ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Abbreviates a system notation path
ustrSystemPath[in] | the full system path to abbreviate |
pustrCompacted[out] | receives the compacted system path on output |
pfnCalcWidth[in] | function ptr that calculates the width of a string. Can be zero. |
uMaxWidth[in] | maximum width allowed that is retunrned from pfnCalcWidth. If pfnCalcWidth is zero the character count is assumed as width. |
osl_File_E_None on success otherwise one osl_File_E_INVAL
oslDirectoryItem | Item ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Increases the refcount of a directory item handle
Item | a handle received by a call to <code>osl_getDirectoryItem</code>, <code>osl_getNextDirectoryItem</code>. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_INVAL the format of the parameters was not valid<p>
oslVolumeDeviceHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
oslVolumeDeviceHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
oslDirectory | Directory ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Releases a directory handle
Directory | a handle received by a call to <code>osl_openDirectory</code>. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <p> These errorcodes can (eventually) be returned:<p> osl_File_E_BADF Invalid oslDirectory parameter<br> osl_File_E_INTR function call was interrupted<p>
oslFileHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Closes an open file.
Handle | Handle to a file previously open by a call to <code>osl_openFile</code>. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<p> These errorcodes can (eventually) be returned:<p> osl_File_E_BADF Bad file<br> osl_File_E_INTR function call was interrupted<br> osl_File_E_NOLINK Link has been severed<br> osl_File_E_NOSPC No space left on device<br> osl_File_E_IO I/O error<p>
rtl_uString * | strPath, |
rtl_uString * | strDestPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Copies a file to a new destination. Copies only files not directories. No assumptions should be made about preserving attributes or file time.
strPath | Full qualified UNC path of the source file. |
strDestPath | Full qualified UNC path of the destination file. A directory is NOT a valid destination file ! |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_ACCES Permission denied<br> osl_File_E_PERM Operation not permitted<br> osl_File_E_NAMETOOLONG File name too long<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_ISDIR Is a directory<br> osl_File_E_ROFS Read-only file system<p>
rtl_uString * | strPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Creates a directory.
strPatg | Full qualified UNC path of the directory to create. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_EXIST File exists<br> osl_File_E_ACCES Permission denied<br> osl_File_E_NAMETOOLONG File name too long<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_NOTDIR Not a directory<br> osl_File_E_ROFS Read-only file system<br> osl_File_E_NOSPC No space left on device<br> osl_File_E_DQUOT Quota exceeded<p> These errorcodes can (eventually) be returned:<p> osl_File_E_LOOP Too many symbolic links encountered<br> osl_File_E_FAULT Bad address<br> osl_FileE_IO I/O error<br> osl_File_E_MLINK Too many links<br> osl_File_E_MULTIHOP Multihop attempted<br> osl_File_E_NOLINK Link has been severed<p>
rtl_uString * | strDirBase, |
rtl_uString * | strRelative, |
rtl_uString * * | strAbsolute ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Converts a path relative to a given directory into an full qualified UNC path.
strDirBase | Base directory to which the relative path is related to. |
strRelative[in] | Path of a file or directory relative to the directory path specified by <code>strDirBase</code>. |
strAbsolute | On success it receives the full qualified UNC path of the requested relative path. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_NOTDIR Not a directory<br> osl_File_E_ACCES Permission denied<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_NAMETOOLONG File name too long<p> These errorcodes can (eventually) be returned:<p> osl_File_E_OVERFLOW Value too large for defined data type<p> osl_File_E_FAULT Bad address<br> osl_File_E_INTR function call was interrupted<br> osl_File_E_LOOP Too many symbolic links encountered<br> osl_File_E_MULTIHOP Multihop attempted<br> osl_File_E_NOLINK Link has been severed<p>
rtl_uString * | strRequested, |
rtl_uString * * | strValid ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Determines a valid unused canonical name for a requested name. Depending on file system and operation system the illegal characters are replaced by valid ones. If a file or directory with the requested name already exists a new name is generated following the common rules on the actual file system and operating system.
strRequested | Requested name of a file or directory. |
strValid | On success receives a name which is unused and valid on the actual operating system and file system. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br>
rtl_uString * | strFilePath, |
oslDirectoryItem * | pItem ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Retrieves a single directory item handle with an initial refcount of 1.
strFilePath | absolute file path following the notation explained in the documentation for <code>osl_openDirectory</code>. Due to performance issues it is not recommended to use this function while enumerating the contents of a directory. In this case use <code>osl_getNextDirectoryItem</code> instead. |
pItem | on success it receives a handle which can be used for subsequent calls to <code>osl_getFileStatus</code>. The handle has to be released by a call to <code>osl_releaseDirectoryItem</code>. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_ACCES permission denied<br> osl_File_E_MFILE too many open files used by the process<br> osl_File_E_NFILE too many open files in the system<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_LOOP Too many symbolic links encountered<br> osl_File_E_NAMETOOLONG File name too long<br> osl_File_E_NOTDIR A component of the path prefix of path is not a directory<p> These errorcodes can (eventually) be returned:<p> osl_File_E_IO I/O error<br> osl_File_E_MULTIHOP Multihop attempted<br> osl_File_E_NOLINK Link has been severed<br> osl_File_E_FAULT Bad address<br> osl_File_E_INTR function call was interrupted<p>
oslFileHandle | Handle, |
sal_uInt64 * | pPos ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Retrieves the current position of the internal pointer of an open file.
Handle | Handle to an open file. |
pPos | On Success it receives the current position of the file pointer. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_OVERFLOW The resulting file offset would be a value which cannot be represented correctly for regular files<p>
oslDirectoryItem | Item, |
oslFileStatus * | pStatus, |
sal_uInt32 | uFieldMask ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Retrieves information about a single file or directory
Item | a handle received by a previous call to <code>osl_getDirectoryItem</code>, <code>osl_getNextDirectoryItem</code>. |
pStatus | points to a structure which receives the information of the file or directory represented by the handle <code>Item</code>. The member <code>uStructSize</code> has to be initialized to <code>sizeof(oslFileStatus)</code> before calling this function. |
uFieldMask | specifies which fields of the structure pointed to by <code>pStatus</code> are of interest to the caller. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_LOOP Too many symbolic links encountered<br> osl_File_E_ACCES Permission denied<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_NAMETOOLONG file name too long<p> These errorcodes can (eventually) be returned:<p> osl_File_E_BADF Invalid oslDirectoryItem parameter<br> osl_File_E_FAULT Bad address<br> osl_File_E_OVERFLOW Value too large for defined data type<br> osl_File_E_INTR function call was interrupted<br> osl_File_E_NOLINK Link has been severed<br> osl_File_E_MULTIHOP Components of path require hopping to multiple remote machines and the file system does not allow it<br> osl_File_E_MFILE too many open files used by the process<br> osl_File_E_NFILE too many open files in the system<br> osl_File_E_NOSPC No space left on device<br> osl_File_E_NXIO No such device or address<br> osl_File_E_IO I/O error<br> osl_File_E_NOSYS Function not implemented<p>
rtl_uString * | ustrSystemPath, |
rtl_uString * * | pustrFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Converts a system dependend path into a FileURL
dir[in] | System dependent path of a file or directory |
strPath[out] | On success it receives the file URL |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br>
oslDirectory | Directory, |
oslDirectoryItem * | pItem, |
sal_uInt32 | uHint ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Retrieves the next item(s) of a previously openend directory. All handles have an initial refcount of 1.
Directory | is the directory handle received from a previous call to <code>osl_openDirectory</code>. |
pItem | On success it receives a handle that can be used for subsequent calls to <code>osl_getFileStatus</code>. The handle has to be released by a call to <code>osl_releaseDirectoryItem</code>. |
uHint | 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. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_NOENT No more entries in this directory<p> These errorcodes can (eventually) be returned:<p> osl_File_E_BADF oslDirectory parameter is not valid<br> osl_File_E_OVERFLOW Value too large for defined data type<p>
rtl_uString * | ustrFileURL, |
rtl_uString * * | pustrSystemPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Converts a file URL in a system dependend path
dir[in] | File URL |
strPath[out] | On success it receives the system dependent path of a file or a directory |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br>
oslVolumeDeviceHandle | Handle, |
rtl_uString * * | pstrPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Gets the normalized absolute file system path where a device is mounted to.
Handle | Device handle of the volume retrieved with <code>osl_getVolumeInformation</code>. |
pstrPath | Receives the path where the device is mounted to. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_ACCES permission denied<br> osl_File_E_NXIO No such device or address<br> osl_File_E_NODEV No such device<br> osl_File_E_NOENT No such file or directory<br> These errorcodes can (eventually) be returned:<p> osl_File_E_FAULT Bad address<br> osl_FilE_E_INTR function call was interrupted<br> osl_File_E_IO I/O error<br> osl_File_E_MULTIHOP Multihop attempted<br> osl_File_E_NOLINK Link has been severed<br> osl_File_E_EOVERFLOW Value too large for defined data type<p>
rtl_uString * | strDirectory, |
oslVolumeInfo * | pInfo, |
sal_uInt32 | uFieldMask ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
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. Before calling this function <code>osl_getFileStatus</code> should be called to determine if the type is <code>osl_file_Type_Volume</code>.
strDirectory | Full qualified UNC path to the volume |
pInfo | On success it receives information about the volume. |
uFieldMask | Specifies which members of the structure should be filled |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_INVAL the format of the parameters was not valid<p> These errorcodes can (eventually) be returned:<p> osl_File_E_NOTDIR Not a directory<br> osl_File_E_NAMETOOLONG File name too long<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_ACCES permission denied<br> osl_File_E_LOOP Too many symbolic links encountered<br> ols_File_E_FAULT Bad address<br> osl_File_E_IO I/O error<br> osl_File_E_NOSYS Function not implemented<br> osl_File_E_MULTIHOP Multihop attempted<br> osl_File_E_NOLINK Link has been severed<br> osl_File_E_INTR function call was interrupted<p>
oslFileHandle | Handle, |
sal_Bool * | pIsEOF ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Tests if the end of a file is reached.
Handle | Handle to an open file. |
pIsEOF | Points to a variable that receives the end of file status. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> These errorcodes can (eventually) be returned:<p> osl_File_E_INTR function call was interrupted<br> osl_File_E_IO I/O error<br> osl_File_E_ISDIR Is a directory<br> osl_File_E_BADF Bad file<br> osl_File_E_FAULT Bad address<br> osl_File_E_AGAIN Operation would block<br> osl_File_E_NOLINK Link has been severed<p>
rtl_uString * | strPath, |
rtl_uString * | strDestPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Moves a file or directory to a new destination or renames it. File time and attributes are preserved.
strPath | Full qualified UNC path of the source file. |
strDestPath | Full qualified UNC path of the destination file. An existing directory is NOT a valid destination ! |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_ACCES Permission denied<br> osl_File_E_PERM Operation not permitted<br> osl_File_E_NAMETOOLONG File name too long<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_ROFS Read-only file system<p>
rtl_uString * | strDirectoryPath, |
oslDirectory * | pDirectory ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Opens a directory for enumerating its contents.
strDirenctoryPath | Denotes the full qualified path of the directory follwing the UNC notation. The path devider is '/'. Relative path specifications are not allowed. |
pDirectory | on success it receives a handle used for subsequent calls by <code>osl_getNextDirectoryItem</code> on error it receives NULL. The handle has to be released by a call to <code>osl_closeDirectory</code>. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOENT the specified path doesn't exist<br> osl_File_E_NOTDIR the specified path is not an directory <br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_ACCES permission denied<br> osl_File_E_MFILE too many open files used by the process<br> osl_File_E_NFILE too many open files in the system<br> osl_File_E_NAMETOOLONG File name too long<br> osl_File_E_LOOP Too many symbolic links encountered<p>
rtl_uString * | strPath, |
oslFileHandle * | pHandle, |
sal_uInt32 | uFlags ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Opens a file.
strPath | Full qualified path to the file to open. Only regular files can be openend. |
pHandle | On success it receives a handle to the open file. |
uFlags | Specifies the open mode. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NAMETOOLONG pathname was too long<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_ACCES permission denied<p> osl_File_E_AGAIN A write lock could not be established<p> These errorcodes can (eventually) be returned:<p> osl_File_E_NOTDIR Not a directory<br> osl_File_E_NXIO No such device or address<br> osl_File_E_NODEV No such device<br> osl_File_E_ROFS Read-only file system<br> osl_File_E_TXTBSY Text file busy<br> osl_File_E_FAULT Bad address<br> osl_File_E_LOOP Too many symbolic links encountered<br> osl_File_E_NOSPC No space left on device<br> osl_File_E_ISDIR Is a directory<br> osl_File_E_MFILE too many open files used by the process<br> osl_File_E_NFILE too many open files in the system<br> osl_File_E_DQUOT Quota exceeded<br> osl_File_E_EXIST File exists<br> osl_FilE_E_INTR function call was interrupted<br> osl_File_E_IO I/O error<br> osl_File_E_MULTIHOP Multihop attempted<br> osl_File_E_NOLINK Link has been severed<br> osl_File_E_EOVERFLOW Value too large for defined data type<p>
oslFileHandle | Handle, |
void * | pBuffer, |
sal_uInt64 | uBytesRequested, |
sal_uInt64 * | pBytesRead ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Reads a number of bytes from a file. The internal file pointer is increased by the number of bytes read.
Handle | Handle to an open file. |
pBuffer | Points to a buffer which receives data. The buffer must be large enough to hold <code>uBytesRequested</code> bytes. |
uBytesRequested | Number of bytes which should be retrieved. |
pBytesRead | On success the number of bytes which have actually been retrieved. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> These errorcodes can (eventually) be returned:<p> osl_File_E_INTR function call was interrupted<br> osl_File_E_IO I/O error<br> osl_File_E_ISDIR Is a directory<br> osl_File_E_BADF Bad file<br> osl_File_E_FAULT Bad address<br> osl_File_E_AGAIN Operation would block<br> osl_File_E_NOLINK Link has been severed<p>
oslFileHandle | Handle, |
sal_Sequence * * | ppSequence ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Reads a line from given file. The new line delemeter(s) are NOT returned!
Handle | Handle to an open file. |
ppSequence | a pointer to a valid sequence. Will hold the line read on return. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> These errorcodes can (eventually) be returned:<p> osl_File_E_INTR function call was interrupted<br> osl_File_E_IO I/O error<br> osl_File_E_ISDIR Is a directory<br> osl_File_E_BADF Bad file<br> osl_File_E_FAULT Bad address<br> osl_File_E_AGAIN Operation would block<br> osl_File_E_NOLINK Link has been severed<p>
oslDirectoryItem | Item ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Decreases the refcount of a directory item handle and releases the data if the refcount reaches 0.
Item | a handle received by a call to <code>osl_getDirectoryItem</code>, <code>osl_getNextDirectoryItem</code>. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_INVAL the format of the parameters was not valid<p>
oslVolumeDeviceHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
rtl_uString * | strPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Removes an empty directory.
strPath | Full qualified UNC path of the directory. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_PERM Operation not permitted<br> osl_File_E_ACCES Permission denied<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_NOTDIR Not a directory<br> osl_File_E_NOTEMPTY Directory not empty<p> These errorcodes can (eventually) be returned:<p> osl_File_E_FAULT Bad address<br> osl_File_E_NAMETOOLONG File name too long<br> osl_File_E_BUSY Device or resource busy<br> osl_File_E_ROFS Read-only file system<br> osl_File_E_LOOP Too many symbolic links encountered<br> osl_File_E_BUSY Device or resource busy<br> osl_File_E_EXIST File exists<br> osl_File_E_IO I/O error<br> osl_File_E_MULTIHOP Multihop attempted<br> osl_File_E_NOLINK Link has been severed<p>
rtl_uString * | strPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Removes (erases) a regular file.
strPath | Full qualified UNC path of the directory. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOMEM not enough memory for allocating structures <br> osl_File_E_ACCES Permission denied<br> osl_File_E_PERM Operation not permitted<br> osl_File_E_NAMETOOLONG File name too long<br> osl_File_E_NOENT No such file or directory<br> osl_File_E_ISDIR Is a directory<br> osl_File_E_ROFS Read-only file system<p> These errorcodes can (eventually) be returned:<p> osl_File_E_FAULT Bad address<br> osl_File_E_LOOP Too many symbolic links encountered<br> osl_File_E_IO I/O error<br> osl_File_E_BUSY Device or resource busy<br> osl_File_E_INTR function call was interrupted<br> osl_File_E_LOOP Too many symbolic links encountered<br> osl_File_E_MULTIHOP Multihop attempted<br> osl_File_E_NOLINK Link has been severed<br> osl_File_E_TXTBSY Text file busy<p>
rtl_uString * | ustrFileName, |
rtl_uString * | ustrSearchPath, |
rtl_uString * * | pustrFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Searches a full qualified UNC-Path/File
filePath[in] | System dependent path / Normalized Path / File-URL or file or relative directory |
searchPath[in] | Paths, in which a given file has to be searched. These paths are only for the search of a file or a relative path, otherwise it will be ignored. If it is set to NULL or while using the search path the search failed the function searches for a matching file in all system directories and in the directories listed in the PATH environment variable |
strPath[out] | On success it receives the full qualified UNC path |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOTDIR Not a directory<br> osl_File_E_NOENT No such file or directory not found<br>
rtl_uString * | filePath, |
sal_uInt64 | uAttributes ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Sets file-attributes
filePath[in] | Path of the file |
uAttributes[in] | Attributes of the file to be set |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br>
oslFileHandle | Handle, |
sal_uInt32 | uHow, |
sal_Int64 | uPos ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Sets the internal position pointer of an open file.
Handle | Handle of an open file received by a previous call to <code>osl_openFile</code>. |
uHow | Distance to move the internal position pointer (from uPos). |
uPos | Absolute position from the beginning of the file. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_OVERFLOW The resulting file offset would be a value which cannot be represented correctly for regular files<p>
oslFileHandle | Handle, |
sal_uInt64 | uSize ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Sets the file size of an open file. The file can be truncated or enlarged by the function. The position of the file pointer is not affeced by this function.
Handle | Handle to an open file. |
uSize | New size in bytes. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_OVERFLOW The resulting file offset would be a value which cannot be represented correctly for regular files<p>
rtl_uString * | filePath, |
TimeValue * | aCreationTime, |
TimeValue * | aLastAccessTime, |
TimeValue * | aLastWriteTime ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Sets file-Time
filePath[in] | Path of the file |
aCreationTime[in] | creation time of the given file |
aLastAccessTime[in] | time of the last access of the given file |
aLastWriteTime[in] | time of the last modifying of the given file |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_NOENT No such file or directory not found<br>
oslVolumeDeviceHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
oslFileHandle | Handle, |
const void * | pBuffer, |
sal_uInt64 | uBytesToWrite, |
sal_uInt64 * | pBytesWritten ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Writes a number of bytes to a file. The internal file pointer is increased by the number of bytes read.
Handle | Handle to an open file. |
pBuffer | Points to a buffer which contains the data. |
uBytesToWrite | Number of bytes which should be written. |
pBytesWritten | On success the number of bytes which have actually been written. |
osl_File_E_None on success otherwise one of the following errorcodes:<p> osl_File_E_INVAL the format of the parameters was not valid<br> osl_File_E_FBIG File too large<br> osl_File_E_DQUOT Quota exceeded<p> These errorcodes can (eventually) be returned:<p> osl_File_E_AGAIN Operation would block<br> osl_File_E_BADF Bad file<br> osl_File_E_FAULT Bad address<br> osl_File_E_INTR function call was interrupted<br> osl_File_E_IO I/O error<br> osl_File_E_NOLCK No record locks available<br> osl_File_E_NOLINK Link has been severed<br> osl_File_E_NOSPC No space left on device<br> osl_File_E_NXIO No such device or address<p>
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.