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 |
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. |
oslDirectoryItem | Item ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Item | a handle received by a call to |
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_INVAL the format of the parameters was not valid
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 |
Directory | a handle received by a call to |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
These errorcodes can (eventually) be returned:
osl_File_E_BADF Invalid oslDirectory parameter
osl_File_E_INTR function call was interrupted
oslFileHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | Handle to a file previously open by a call to |
osl_File_E_INVAL the format of the parameters was not valid
These errorcodes can (eventually) be returned:
osl_File_E_BADF Bad file
osl_File_E_INTR function call was interrupted
osl_File_E_NOLINK Link has been severed
osl_File_E_NOSPC No space left on device
osl_File_E_IO I/O error
rtl_uString * | strPath, |
rtl_uString * | strDestPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
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_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_ACCES Permission denied
osl_File_E_PERM Operation not permitted
osl_File_E_NAMETOOLONG File name too long
osl_File_E_NOENT No such file or directory
osl_File_E_ISDIR Is a directory
osl_File_E_ROFS Read-only file system
rtl_uString * | strPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
strPatg | Full qualified UNC path of the directory to create. |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_EXIST File exists
osl_File_E_ACCES Permission denied
osl_File_E_NAMETOOLONG File name too long
osl_File_E_NOENT No such file or directory
osl_File_E_NOTDIR Not a directory
osl_File_E_ROFS Read-only file system
osl_File_E_NOSPC No space left on device
osl_File_E_DQUOT Quota exceeded
These errorcodes can (eventually) be returned:
osl_File_E_LOOP Too many symbolic links encountered
osl_File_E_FAULT Bad address
osl_FileE_IO I/O error
osl_File_E_MLINK Too many links
osl_File_E_MULTIHOP Multihop attempted
osl_File_E_NOLINK Link has been severed
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 |
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 |
strAbsolute | On success it receives the full qualified UNC path of the requested relative path. |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_NOTDIR Not a directory
osl_File_E_ACCES Permission denied
osl_File_E_NOENT No such file or directory
osl_File_E_NAMETOOLONG File name too long
These errorcodes can (eventually) be returned:
osl_File_E_OVERFLOW Value too large for defined data type
osl_File_E_FAULT Bad address
osl_File_E_INTR function call was interrupted
osl_File_E_LOOP Too many symbolic links encountered
osl_File_E_MULTIHOP Multihop attempted
osl_File_E_NOLINK Link has been severed
rtl_uString * | strRequested, |
rtl_uString * * | strValid ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
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_INVAL the format of the parameters was not valid
rtl_uString * | strFilePath, |
oslDirectoryItem * | pItem ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
strFilePath | absolute file path following the notation explained in the documentation for |
pItem | on success it receives a handle which can be used for subsequent calls to |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_ACCES permission denied
osl_File_E_MFILE too many open files used by the process
osl_File_E_NFILE too many open files in the system
osl_File_E_NOENT No such file or directory
osl_File_E_LOOP Too many symbolic links encountered
osl_File_E_NAMETOOLONG File name too long
osl_File_E_NOTDIR A component of the path prefix of path is not a directory
These errorcodes can (eventually) be returned:
osl_File_E_IO I/O error
osl_File_E_MULTIHOP Multihop attempted
osl_File_E_NOLINK Link has been severed
osl_File_E_FAULT Bad address
osl_File_E_INTR function call was interrupted
oslFileHandle | Handle, |
sal_uInt64 * | pPos ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | Handle to an open file. |
pPos | On Success it receives the current position of the file pointer. |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_OVERFLOW The resulting file offset would be a value which cannot
be represented correctly for regular files
oslDirectoryItem | Item, |
oslFileStatus * | pStatus, |
sal_uInt32 | uFieldMask ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Item | a handle received by a previous call to |
pStatus | points to a structure which receives the information of the file or directory represented by the handle |
uFieldMask | specifies which fields of the structure pointed to by |
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_LOOP Too many symbolic links encountered
osl_File_E_ACCES Permission denied
osl_File_E_NOENT No such file or directory
osl_File_E_NAMETOOLONG file name too long
These errorcodes can (eventually) be returned:
osl_File_E_BADF Invalid oslDirectoryItem parameter
osl_File_E_FAULT Bad address
osl_File_E_OVERFLOW Value too large for defined data type
osl_File_E_INTR function call was interrupted
osl_File_E_NOLINK Link has been severed
osl_File_E_MULTIHOP Components of path require hopping to multiple remote machines and the file system does not allow it
osl_File_E_MFILE too many open files used by the process
osl_File_E_NFILE too many open files in the system
osl_File_E_NOSPC No space left on device
osl_File_E_NXIO No such device or address
osl_File_E_IO I/O error
osl_File_E_NOSYS Function not implemented
rtl_uString * | ustrSystemPath, |
rtl_uString * * | pustrFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
dir[in] | System dependent path of a file or directory |
strPath[out] | On success it receives the file URL |
osl_File_E_INVAL the format of the parameters was not valid
oslDirectory | Directory, |
oslDirectoryItem * | pItem, |
sal_uInt32 | uHint ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Directory | is the directory handle received from a previous call to |
pItem | On success it receives a handle that can be used for subsequent calls to |
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_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_NOENT No more entries in this directory
These errorcodes can (eventually) be returned:
osl_File_E_BADF oslDirectory parameter is not valid
osl_File_E_OVERFLOW Value too large for defined data type
rtl_uString * | ustrFileURL, |
rtl_uString * * | pustrSystemPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
dir[in] | File URL |
strPath[out] | On success it receives the system dependent path of a file or a directory |
osl_File_E_INVAL the format of the parameters was not valid
oslVolumeDeviceHandle | Handle, |
rtl_uString * * | pstrPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | Device handle of the volume retrieved with |
pstrPath | Receives the path where the device is mounted to. |
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_ACCES permission denied
osl_File_E_NXIO No such device or address
osl_File_E_NODEV No such device
osl_File_E_NOENT No such file or directory
These errorcodes can (eventually) be returned:
osl_File_E_FAULT Bad address
osl_FilE_E_INTR function call was interrupted
osl_File_E_IO I/O error
osl_File_E_MULTIHOP Multihop attempted
osl_File_E_NOLINK Link has been severed
osl_File_E_EOVERFLOW Value too large for defined data type
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 |
osl_getFileStatus
should be called to determine if the type is
osl_file_Type_Volume
.
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_NOMEM not enough memory for allocating structures
osl_File_E_INVAL the format of the parameters was not valid
These errorcodes can (eventually) be returned:
osl_File_E_NOTDIR Not a directory
osl_File_E_NAMETOOLONG File name too long
osl_File_E_NOENT No such file or directory
osl_File_E_ACCES permission denied
osl_File_E_LOOP Too many symbolic links encountered
ols_File_E_FAULT Bad address
osl_File_E_IO I/O error
osl_File_E_NOSYS Function not implemented
osl_File_E_MULTIHOP Multihop attempted
osl_File_E_NOLINK Link has been severed
osl_File_E_INTR function call was interrupted
oslFileHandle | Handle, |
sal_Bool * | pIsEOF ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | Handle to an open file. |
pIsEOF | Points to a variable that receives the end of file status. |
osl_File_E_INVAL the format of the parameters was not valid
These errorcodes can (eventually) be returned:
osl_File_E_INTR function call was interrupted
osl_File_E_IO I/O error
osl_File_E_ISDIR Is a directory
osl_File_E_BADF Bad file
osl_File_E_FAULT Bad address
osl_File_E_AGAIN Operation would block
osl_File_E_NOLINK Link has been severed
rtl_uString * | strPath, |
rtl_uString * | strDestPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
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_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_ACCES Permission denied
osl_File_E_PERM Operation not permitted
osl_File_E_NAMETOOLONG File name too long
osl_File_E_NOENT No such file or directory
osl_File_E_ROFS Read-only file system
rtl_uString * | strDirectoryPath, |
oslDirectory * | pDirectory ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
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 |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_NOENT the specified path doesn't exist
osl_File_E_NOTDIR the specified path is not an directory
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_ACCES permission denied
osl_File_E_MFILE too many open files used by the process
osl_File_E_NFILE too many open files in the system
osl_File_E_NAMETOOLONG File name too long
osl_File_E_LOOP Too many symbolic links encountered
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 |
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_NOMEM not enough memory for allocating structures
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_NAMETOOLONG pathname was too long
osl_File_E_NOENT No such file or directory
osl_File_E_ACCES permission denied
osl_File_E_AGAIN A write lock could not be established
These errorcodes can (eventually) be returned:
osl_File_E_NOTDIR Not a directory
osl_File_E_NXIO No such device or address
osl_File_E_NODEV No such device
osl_File_E_ROFS Read-only file system
osl_File_E_TXTBSY Text file busy
osl_File_E_FAULT Bad address
osl_File_E_LOOP Too many symbolic links encountered
osl_File_E_NOSPC No space left on device
osl_File_E_ISDIR Is a directory
osl_File_E_MFILE too many open files used by the process
osl_File_E_NFILE too many open files in the system
osl_File_E_DQUOT Quota exceeded
osl_File_E_EXIST File exists
osl_FilE_E_INTR function call was interrupted
osl_File_E_IO I/O error
osl_File_E_MULTIHOP Multihop attempted
osl_File_E_NOLINK Link has been severed
osl_File_E_EOVERFLOW Value too large for defined data type
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 |
Handle | Handle to an open file. |
pBuffer | Points to a buffer which receives data. The buffer must be large enough
to hold |
uBytesRequested | Number of bytes which should be retrieved. |
pBytesRead | On success the number of bytes which have actually been retrieved. |
osl_File_E_INVAL the format of the parameters was not valid
These errorcodes can (eventually) be returned:
osl_File_E_INTR function call was interrupted
osl_File_E_IO I/O error
osl_File_E_ISDIR Is a directory
osl_File_E_BADF Bad file
osl_File_E_FAULT Bad address
osl_File_E_AGAIN Operation would block
osl_File_E_NOLINK Link has been severed
oslFileHandle | Handle, |
sal_Sequence * * | ppSequence ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | Handle to an open file. |
ppSequence | a pointer to a valid sequence. Will hold the line read on return. |
osl_File_E_INVAL the format of the parameters was not valid
These errorcodes can (eventually) be returned:
osl_File_E_INTR function call was interrupted
osl_File_E_IO I/O error
osl_File_E_ISDIR Is a directory
osl_File_E_BADF Bad file
osl_File_E_FAULT Bad address
osl_File_E_AGAIN Operation would block
osl_File_E_NOLINK Link has been severed
oslDirectoryItem | Item ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Item | a handle received by a call to |
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_INVAL the format of the parameters was not valid
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 |
strPath | Full qualified UNC path of the directory. |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_PERM Operation not permitted
osl_File_E_ACCES Permission denied
osl_File_E_NOENT No such file or directory
osl_File_E_NOTDIR Not a directory
osl_File_E_NOTEMPTY Directory not empty
These errorcodes can (eventually) be returned:
osl_File_E_FAULT Bad address
osl_File_E_NAMETOOLONG File name too long
osl_File_E_BUSY Device or resource busy
osl_File_E_ROFS Read-only file system
osl_File_E_LOOP Too many symbolic links encountered
osl_File_E_BUSY Device or resource busy
osl_File_E_EXIST File exists
osl_File_E_IO I/O error
osl_File_E_MULTIHOP Multihop attempted
osl_File_E_NOLINK Link has been severed
rtl_uString * | strPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
strPath | Full qualified UNC path of the directory. |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_NOMEM not enough memory for allocating structures
osl_File_E_ACCES Permission denied
osl_File_E_PERM Operation not permitted
osl_File_E_NAMETOOLONG File name too long
osl_File_E_NOENT No such file or directory
osl_File_E_ISDIR Is a directory
osl_File_E_ROFS Read-only file system
These errorcodes can (eventually) be returned:
osl_File_E_FAULT Bad address
osl_File_E_LOOP Too many symbolic links encountered
osl_File_E_IO I/O error
osl_File_E_BUSY Device or resource busy
osl_File_E_INTR function call was interrupted
osl_File_E_LOOP Too many symbolic links encountered
osl_File_E_MULTIHOP Multihop attempted
osl_File_E_NOLINK Link has been severed
osl_File_E_TXTBSY Text file busy
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 |
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_INVAL the format of the parameters was not valid
osl_File_E_NOTDIR Not a directory
osl_File_E_NOENT No such file or directory not found
rtl_uString * | filePath, |
sal_uInt64 | uAttributes ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
filePath[in] | Path of the file |
uAttributes[in] | Attributes of the file to be set |
osl_File_E_INVAL the format of the parameters was not valid
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 |
Handle | Handle of an open file received by a previous call to |
uHow | Distance to move the internal position pointer (from uPos). |
uPos | Absolute position from the beginning of the file. |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_OVERFLOW The resulting file offset would be a value which cannot
be represented correctly for regular files
oslFileHandle | Handle, |
sal_uInt64 | uSize ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | Handle to an open file. |
uSize | New size in bytes. |
osl_File_E_INVAL the format of the parameters was not valid
osl_File_E_OVERFLOW The resulting file offset would be a value which cannot
be represented correctly for regular files
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 |
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_INVAL the format of the parameters was not valid
osl_File_E_NOENT No such file or directory not found
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 |
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_INVAL the format of the parameters was not valid
osl_File_E_FBIG File too large
osl_File_E_DQUOT Quota exceeded
These errorcodes can (eventually) be returned:
osl_File_E_AGAIN Operation would block
osl_File_E_BADF Bad file
osl_File_E_FAULT Bad address
osl_File_E_INTR function call was interrupted
osl_File_E_IO I/O error
osl_File_E_NOLCK No record locks available
osl_File_E_NOLINK Link has been severed
osl_File_E_NOSPC No space left on device
osl_File_E_NXIO No such device or address
Copyright © 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.