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 | The full system path to abbreviate |
pustrCompacted | Receives the compacted system path on output |
pfnCalcWidth | Function ptr that calculates the width of a string. Can be zero. |
uMaxWidth | 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_getDirectoryItem() or osl_getNextDirectoryItem(). |
oslVolumeDeviceHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation(). |
oslVolumeDeviceHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation(). |
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_openDirectory(). |
oslFileHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | Handle to a file received by a previous call to osl_openFile(). |
rtl_uString * | pustrSourceFileURL, |
rtl_uString * | pustrDestFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrSourceFileURL | Full qualified URL of the source file. |
pustrDestFileURL | Full qualified URL of the destination file. A directory is NOT a valid destination file! |
rtl_uString * | pustrDirectoryURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrDirectoryURL | Full qualified URL of the directory to create. |
rtl_uString * | aDirectoryUrl, |
oslDirectoryCreationCallbackFunc | aDirectoryCreationCallbackFunc, |
void * | pData ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
PLEASE NOTE: You cannot rely on getting the error code osl_File_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. |
aDirectoryCreationFunc | [in] Pointer to a function that will be called synchronously for each sub directory that was created. The value of this parameter may be NULL, in this case notifications will not be sent. |
pData | [in] User specified data to be passed to the directory creation callback function. The value of this parameter may be arbitrary and will not be interpreted by osl_createDirectoryPath. |
rtl_uString * | pustrDirectoryURL, |
oslFileHandle * | pHandle, |
rtl_uString * * | ppustrTempFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrDirectoryURL | Specifies the full qualified URL where the temporary file should be created. If pustrDirectoryURL is 0 the path returned by osl_getTempDirURL will be used. |
pHandle | On success receives a handle to the open file. If pHandle is 0 the file will be closed on return, in this case ppustrTempFileURL must not be 0. |
ppustrTempFileURL | On success receives the full qualified URL of the temporary file. If ppustrTempFileURL is 0 the file will be automatically removed on close, in this case pHandle must not be 0. If ppustrTempFileURL is not 0 the caller receives the name of the created file and is responsible for removing the file, in this case *ppustrTempFileURL must be 0 or must point to a valid rtl_uString. |
rtl_uString * | pustrBaseDirectoryURL, |
rtl_uString * | pustrRelativeFileURL, |
rtl_uString * * | ppustrAbsoluteFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrBaseDirectoryURL | Base directory URL to which the relative path is related to. |
pustrRelativeFileURL | An URL of a file or directory relative to the directory path specified by pustrBaseDirectoryURL or an absolute path. If pustrRelativeFileURL denotes an absolute path pustrBaseDirectoryURL will be ignored. |
ppustrAbsoluteFileURL | On success it receives the full qualified absoulte file URL. |
rtl_uString * | pustrRequestedURL, |
rtl_uString * * | ppustrValidURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrRequestedURL | Requested name of a file or directory. |
ppustrValidURL | On success receives a name which is unused and valid on the actual Operating System and File System. |
rtl_uString * | pustrFileURL, |
oslDirectoryItem * | pItem ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrFileURL | An absolute file URL. |
pItem | 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(). |
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 a file received by a previous call to osl_openFile(). |
pPos | On success receives the current position of the file pointer. |
oslFileHandle | Handle, |
sal_uInt64 * | pSize ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | Handle to a file received by a previous call to osl_openFile(). |
pSize | Current size in bytes. |
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 osl_getDirectoryItem() or osl_getNextDirectoryItem(). |
pStatus | Points to a structure which receives the information of the file or directory represented by the handle Item. The member uStructSize has to be initialized to sizeof(oslFileStatus) before calling this function. |
uFieldMask | Specifies which fields of the structure pointed to by pStatus are of interest to the caller. |
rtl_uString * | pustrSystemPath, |
rtl_uString * * | ppustrFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrSystemPath | A System dependent path of a file or directory. |
ppustrFileURL | On success it receives the file URL. |
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 | A directory handle received from a previous call to osl_openDirectory(). |
pItem | On success it receives a handle that can be used for subsequent calls to osl_getFileStatus(). The handle has to be released by a call to osl_releaseDirectoryItem(). |
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. |
rtl_uString * | pustrFileURL, |
rtl_uString * * | ppustrSystemPath ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrFileURL | A File URL. |
ppustrSystemPath | On success it receives the system path. |
rtl_uString * * | pustrTempDirURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrTempDirURL[out] | On success receives the URL of system's temporary directory path. |
oslVolumeDeviceHandle | Handle, |
rtl_uString * * | ppustrDirectoryURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation(). |
ppustrDirectoryURL | Receives the full qualified URL where the device is mounted to. |
rtl_uString * | pustrDirectoryURL, |
oslVolumeInfo * | pInfo, |
sal_uInt32 | uFieldMask ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrDirectoryURL | Full qualified URL of the volume |
pInfo | On success it receives information about the volume. |
uFieldMask | Specifies which members of the structure should be filled |
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 a file received by a previous call to osl_openFile(). |
pIsEOF | Points to a variable that receives the end-of-file status. |
rtl_uString * | pustrSourceFileURL, |
rtl_uString * | pustrDestFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrSourceFileURL | Full qualified URL of the source file. |
pustrDestFileURL | Full qualified URL of the destination file. An existing directory is NOT a valid destination ! |
rtl_uString * | pustrDirectoryURL, |
oslDirectory * | pDirectory ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrDirectoryURL | The full qualified URL of the directory. |
pDirectory | On success it receives a handle used for subsequent calls by osl_getNextDirectoryItem(). The handle has to be released by a call to osl_closeDirectory(). |
rtl_uString * | pustrFileURL, |
oslFileHandle * | pHandle, |
sal_uInt32 | uFlags ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrFileURL | The full qualified URL of the file to open. |
pHandle | On success it receives a handle to the open file. |
uFlags | Specifies the open mode. |
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 a file received by a previous call to osl_openFile(). |
pBuffer | Points to a buffer which receives data. The buffer must be large enough to hold uBytesRequested bytes. |
uBytesRequested | Number of bytes which should be retrieved. |
pBytesRead | On success the number of bytes which have actually been retrieved. |
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 a file received by a previous call to osl_openFile(). |
ppSequence | A pointer pointer to a sal_Sequence that will hold the line read on success. |
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_getDirectoryItem() or osl_getNextDirectoryItem(). |
oslVolumeDeviceHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation(). |
rtl_uString * | pustrDirectoryURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrDirectoryURL | Full qualified URL of the directory. |
rtl_uString * | pustrFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrFileURL | Full qualified URL of the file to remove. |
rtl_uString * | pustrFileName, |
rtl_uString * | pustrSearchPath, |
rtl_uString * * | ppustrFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrFileName | A system dependent path, a file URL, a file or relative directory. |
pustrSearchPath | A list of system paths, in which a given file has to be searched. The Notation of a path list is system dependend, e.g. on UNIX system "/usr/bin:/bin" and on Windows "C:\BIN;C:\BATCH". These paths are only for the search of a file or a relative path, otherwise it will be ignored. If pustrSearchPath is 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. The value of an environment variable should be used (e.g. LD_LIBRARY_PATH) if the caller is not aware of the Operating System and so doesn't know which path list delimiter to use. |
ppustrFileURL | On success it receives the full qualified file URL. |
rtl_uString * | pustrFileURL, |
sal_uInt64 | uAttributes ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrFileURL | The full qualified file URL. |
uAttributes | Attributes of the file to be set. |
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 to a file received by a previous call to osl_openFile(). |
uHow | Distance to move the internal position pointer (from uPos). |
uPos | Absolute position from the beginning of the file. |
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 a file received by a previous call to osl_openFile(). |
uSize | New size in bytes. |
rtl_uString * | pustrFileURL, |
const TimeValue * | aCreationTime, |
const TimeValue * | aLastAccessTime, |
const TimeValue * | aLastWriteTime ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
pustrFileURL | The full qualified URL of the file. |
aCreationTime | Creation time of the given file. |
aLastAccessTime | Time of the last access of the given file. |
aLastWriteTime | Time of the last modifying of the given file. |
oslFileHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | [in] Handle to a file received by a previous call to osl_openFile(). |
In addition to these error codes others may occur as well, for instance:
oslVolumeDeviceHandle | Handle ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | YES |
Handle | An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation(). |
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 a file received by a previous call to osl_openFile(). |
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_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 on I/O errosr
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 © 2010 Sun Microsystems, Inc.