LibreOffice
LibreOffice 6.0 SDK C/C++ API Reference
Classes | Macros | Typedefs | Enumerations | Functions
file.h File Reference

Main goals and usage hints. More...

#include <sal/config.h>
#include <osl/time.h>
#include <rtl/ustring.h>
#include <sal/saldllapi.h>

Go to the source code of this file.

Classes

struct  _oslFileStatus
 Structure containing information about files and directories. More...
 
struct  _oslVolumeInfo
 Structure containing information about volumes. More...
 

Macros

#define osl_File_Attribute_ReadOnly   0x00000001
 
#define osl_File_Attribute_Hidden   0x00000002
 
#define osl_File_Attribute_Executable   0x00000010
 
#define osl_File_Attribute_GrpWrite   0x00000020
 
#define osl_File_Attribute_GrpRead   0x00000040
 
#define osl_File_Attribute_GrpExe   0x00000080
 
#define osl_File_Attribute_OwnWrite   0x00000100
 
#define osl_File_Attribute_OwnRead   0x00000200
 
#define osl_File_Attribute_OwnExe   0x00000400
 
#define osl_File_Attribute_OthWrite   0x00000800
 
#define osl_File_Attribute_OthRead   0x00001000
 
#define osl_File_Attribute_OthExe   0x00002000
 
#define osl_FileStatus_Mask_Type   0x00000001
 
#define osl_FileStatus_Mask_Attributes   0x00000002
 
#define osl_FileStatus_Mask_CreationTime   0x00000010
 
#define osl_FileStatus_Mask_AccessTime   0x00000020
 
#define osl_FileStatus_Mask_ModifyTime   0x00000040
 
#define osl_FileStatus_Mask_FileSize   0x00000080
 
#define osl_FileStatus_Mask_FileName   0x00000100
 
#define osl_FileStatus_Mask_FileURL   0x00000200
 
#define osl_FileStatus_Mask_LinkTargetURL   0x00000400
 
#define osl_FileStatus_Mask_All   0x7FFFFFFF
 
#define osl_FileStatus_Mask_Validate   0x80000000
 
#define osl_Volume_Attribute_Removeable   0x00000001L
 
#define osl_Volume_Attribute_Remote   0x00000002L
 
#define osl_Volume_Attribute_CompactDisc   0x00000004L
 
#define osl_Volume_Attribute_FixedDisk   0x00000008L
 
#define osl_Volume_Attribute_RAMDisk   0x00000010L
 
#define osl_Volume_Attribute_FloppyDisk   0x00000020L
 
#define osl_Volume_Attribute_Case_Is_Preserved   0x00000040L
 
#define osl_Volume_Attribute_Case_Sensitive   0x00000080L
 
#define osl_VolumeInfo_Mask_Attributes   0x00000001L
 
#define osl_VolumeInfo_Mask_TotalSpace   0x00000002L
 
#define osl_VolumeInfo_Mask_UsedSpace   0x00000004L
 
#define osl_VolumeInfo_Mask_FreeSpace   0x00000008L
 
#define osl_VolumeInfo_Mask_MaxNameLength   0x00000010L
 
#define osl_VolumeInfo_Mask_MaxPathLength   0x00000020L
 
#define osl_VolumeInfo_Mask_FileSystemName   0x00000040L
 
#define osl_VolumeInfo_Mask_DeviceHandle   0x00000080L
 
#define osl_VolumeInfo_Mask_FileSystemCaseHandling   0x00000100L
 
#define osl_File_OpenFlag_Read   0x00000001L
 
#define osl_File_OpenFlag_Write   0x00000002L
 
#define osl_File_OpenFlag_Create   0x00000004L
 
#define osl_File_OpenFlag_NoLock   0x00000008L
 
#define osl_Pos_Absolut   1
 
#define osl_Pos_Current   2
 
#define osl_Pos_End   3
 
#define osl_File_MapFlag_RandomAccess   ((sal_uInt32)(0x1))
 Indicate that the file can be accessed randomly (i.e. More...
 
#define osl_File_MapFlag_WillNeed   ((sal_uInt32)(0x2))
 Map flag denoting that the mapped address space will be accessed by the process soon (and it is advantageous for the operating system to already start paging in the data). More...
 

Typedefs

typedef void * oslDirectory
 
typedef void * oslDirectoryItem
 
typedef struct _oslFileStatus oslFileStatus
 Structure containing information about files and directories. More...
 
typedef void * oslVolumeDeviceHandle
 
typedef struct _oslVolumeInfo oslVolumeInfo
 Structure containing information about volumes. More...
 
typedef void * oslFileHandle
 
typedef void(* oslDirectoryCreationCallbackFunc) (void *pData, rtl_uString *aDirectoryUrl)
 Function pointer representing a function that will be called by osl_createDirectoryPath if a directory has been created. More...
 
typedef sal_uInt32(* oslCalcTextWidthFunc) (rtl_uString *ustrText)
 Function pointer representing the function called back from osl_abbreviateSystemPath. More...
 

Enumerations

enum  oslFileError {
  osl_File_E_None, osl_File_E_PERM, osl_File_E_NOENT, osl_File_E_SRCH,
  osl_File_E_INTR, osl_File_E_IO, osl_File_E_NXIO, osl_File_E_2BIG,
  osl_File_E_NOEXEC, osl_File_E_BADF, osl_File_E_CHILD, osl_File_E_AGAIN,
  osl_File_E_NOMEM, osl_File_E_ACCES, osl_File_E_FAULT, osl_File_E_BUSY,
  osl_File_E_EXIST, osl_File_E_XDEV, osl_File_E_NODEV, osl_File_E_NOTDIR,
  osl_File_E_ISDIR, osl_File_E_INVAL, osl_File_E_NFILE, osl_File_E_MFILE,
  osl_File_E_NOTTY, osl_File_E_FBIG, osl_File_E_NOSPC, osl_File_E_SPIPE,
  osl_File_E_ROFS, osl_File_E_MLINK, osl_File_E_PIPE, osl_File_E_DOM,
  osl_File_E_RANGE, osl_File_E_DEADLK, osl_File_E_NAMETOOLONG, osl_File_E_NOLCK,
  osl_File_E_NOSYS, osl_File_E_NOTEMPTY, osl_File_E_LOOP, osl_File_E_ILSEQ,
  osl_File_E_NOLINK, osl_File_E_MULTIHOP, osl_File_E_USERS, osl_File_E_OVERFLOW,
  osl_File_E_NOTREADY, osl_File_E_invalidError, osl_File_E_TIMEDOUT, osl_File_E_NETWORK,
  osl_File_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
}
 
enum  oslFileType {
  osl_File_Type_Directory, osl_File_Type_Volume, osl_File_Type_Regular, osl_File_Type_Fifo,
  osl_File_Type_Socket, osl_File_Type_Link, osl_File_Type_Special, osl_File_Type_Unknown
}
 

Functions

SAL_DLLPUBLIC oslFileError osl_openDirectory (rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
 Open a directory for enumerating its contents. More...
 
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem (oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
 Retrieve the next item of a previously opened directory. More...
 
SAL_DLLPUBLIC oslFileError osl_closeDirectory (oslDirectory Directory)
 Release a directory handle. More...
 
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem (rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
 Retrieve a single directory item. More...
 
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem (oslDirectoryItem Item)
 Increase the refcount of a directory item handle. More...
 
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem (oslDirectoryItem Item)
 Decrease the refcount of a directory item handle. More...
 
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem (oslDirectoryItem pItemA, oslDirectoryItem pItemB)
 Determine if two directory items point the same underlying file. More...
 
SAL_DLLPUBLIC oslFileError osl_getFileStatus (oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask)
 Retrieve information about a single file or directory. More...
 
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle (oslVolumeDeviceHandle Handle)
 Release a volume device handle. More...
 
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle (oslVolumeDeviceHandle Handle)
 Acquire a volume device handle. More...
 
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath (oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
 Get the full qualified URL where a device is mounted to. More...
 
SAL_DLLPUBLIC oslFileError osl_getVolumeInformation (rtl_uString *pustrDirectoryURL, oslVolumeInfo *pInfo, sal_uInt32 uFieldMask)
 Retrieve information about a volume. More...
 
SAL_DLLPUBLIC oslFileError osl_openFile (rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
 Open a regular file. More...
 
SAL_DLLPUBLIC oslFileError osl_setFilePos (oslFileHandle Handle, sal_uInt32 uHow, sal_Int64 uPos) SAL_WARN_UNUSED_RESULT
 Set the internal position pointer of an open file. More...
 
SAL_DLLPUBLIC oslFileError osl_getFilePos (oslFileHandle Handle, sal_uInt64 *pPos)
 Retrieve the current position of the internal pointer of an open file. More...
 
SAL_DLLPUBLIC oslFileError osl_setFileSize (oslFileHandle Handle, sal_uInt64 uSize)
 Set the file size of an open file. More...
 
SAL_DLLPUBLIC oslFileError osl_getFileSize (oslFileHandle Handle, sal_uInt64 *pSize)
 Get the file size of an open file. More...
 
SAL_DLLPUBLIC oslFileError osl_mapFile (oslFileHandle Handle, void **ppAddr, sal_uInt64 uLength, sal_uInt64 uOffset, sal_uInt32 uFlags)
 Map a shared file into memory. More...
 
SAL_DLLPUBLIC oslFileError osl_unmapFile (void *pAddr, sal_uInt64 uLength)
 Unmap a shared file from memory. More...
 
SAL_DLLPUBLIC oslFileError osl_unmapMappedFile (oslFileHandle Handle, void *pAddr, sal_uInt64 uLength)
 Unmap a file segment from memory. More...
 
SAL_DLLPUBLIC oslFileError osl_readFile (oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead)
 Read a number of bytes from a file. More...
 
SAL_DLLPUBLIC oslFileError osl_isEndOfFile (oslFileHandle Handle, sal_Bool *pIsEOF)
 Test if the end of a file is reached. More...
 
SAL_DLLPUBLIC oslFileError osl_writeFile (oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten)
 Write a number of bytes to a file. More...
 
SAL_DLLPUBLIC oslFileError osl_readFileAt (oslFileHandle Handle, sal_uInt64 uOffset, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead)
 Read a number of bytes from a specified offset in a file. More...
 
SAL_DLLPUBLIC oslFileError osl_writeFileAt (oslFileHandle Handle, sal_uInt64 uOffset, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten)
 Write a number of bytes to a specified offset in a file. More...
 
SAL_DLLPUBLIC oslFileError osl_readLine (oslFileHandle Handle, sal_Sequence **ppSequence)
 Read a line from a file. More...
 
SAL_DLLPUBLIC oslFileError osl_syncFile (oslFileHandle Handle)
 Synchronize the memory representation of a file with that on the physical medium. More...
 
SAL_DLLPUBLIC oslFileError osl_closeFile (oslFileHandle Handle)
 Close an open file. More...
 
SAL_DLLPUBLIC oslFileError osl_createDirectory (rtl_uString *pustrDirectoryURL)
 Create a directory. More...
 
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags (rtl_uString *url, sal_uInt32 flags)
 Create a directory, passing flags. More...
 
SAL_DLLPUBLIC oslFileError osl_removeDirectory (rtl_uString *pustrDirectoryURL)
 Remove an empty directory. More...
 
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath (rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
 Create a directory path. More...
 
SAL_DLLPUBLIC oslFileError osl_removeFile (rtl_uString *pustrFileURL)
 Remove a regular file. More...
 
SAL_DLLPUBLIC oslFileError osl_copyFile (rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
 Copy a file to a new destination. More...
 
SAL_DLLPUBLIC oslFileError osl_moveFile (rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
 Move a file or directory to a new destination or renames it. More...
 
SAL_DLLPUBLIC oslFileError osl_getCanonicalName (rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
 Determine a valid unused canonical name for a requested name. More...
 
SAL_DLLPUBLIC oslFileError osl_getAbsoluteFileURL (rtl_uString *pustrBaseDirectoryURL, rtl_uString *pustrRelativeFileURL, rtl_uString **ppustrAbsoluteFileURL)
 Convert a path relative to a given directory into an full qualified file URL. More...
 
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath (rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
 Convert a system dependent path into a file URL. More...
 
SAL_DLLPUBLIC oslFileError osl_searchFileURL (rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL)
 Search a full qualified system path or a file URL. More...
 
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL (rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
 Convert a file URL into a system dependent path. More...
 
SAL_DLLPUBLIC oslFileError osl_abbreviateSystemPath (rtl_uString *ustrSystemPath, rtl_uString **pustrCompacted, sal_uInt32 uMaxWidth, oslCalcTextWidthFunc pCalcWidth)
 Abbreviate a system notation path. More...
 
SAL_DLLPUBLIC oslFileError osl_setFileAttributes (rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
 Set file attributes. More...
 
SAL_DLLPUBLIC oslFileError osl_setFileTime (rtl_uString *pustrFileURL, const TimeValue *aCreationTime, const TimeValue *aLastAccessTime, const TimeValue *aLastWriteTime)
 Set the file time. More...
 
SAL_DLLPUBLIC oslFileError osl_getTempDirURL (rtl_uString **pustrTempDirURL)
 Retrieves the file URL of the system's temporary directory path. More...
 
SAL_DLLPUBLIC oslFileError osl_createTempFile (rtl_uString *pustrDirectoryURL, oslFileHandle *pHandle, rtl_uString **ppustrTempFileURL)
 Creates a temporary file in the directory provided by the caller or the directory returned by osl_getTempDirURL. More...
 

Detailed Description

Main goals and usage hints.

The main intention of this interface is to provide an universal portable and high performance access to file system functionality on any operating system.

There are a few main goals:

  1. The path specifications always has to be absolute. Any usage of relative path specifications is forbidden. Exceptions are osl_getSystemPathFromFileURL, osl_getFileURLFromSystemPath and osl_getAbsoluteFileURL. Most operating systems provide a "Current Directory" per process. This is the reason why relative path specifications can cause problems in multithreading environments.
  2. Proprietary notations of file paths are not supported. Every path notation must the file URL specification. File URLs must be encoded in UTF8 and after that escaped. Although the URL parameter is a unicode string, the must contain only ASCII characters.
  3. The caller cannot get any information whether a file system is case sensitive, case preserving or not. The operating system implementation itself should determine if it can map case-insensitive paths. The case correct notation of a filename or file path is part of the "File Info". This case correct name can be used as a unique key if necessary.
  4. Obtaining information about files or volumes is controlled by a bitmask which specifies which fields are of interest. Due to performance reasons it is not recommended to obtain information which is not needed. But if the operating system provides more information anyway the implementation can set more fields on output as were requested. It is in the responsibility of the caller to decide if they use this additional information or not. But they should do so to prevent further unnecessary calls if the information is already there.

The input bitmask supports a flag osl_FileStatus_Mask_Validate which can be used to force retrieving uncached validated information. Setting this flag when calling osl_getFileStatus in combination with no other flag is a synonym for a "FileExists". This should only be done when processing a single file (i.e. before opening) and NEVER during enumeration of directory contents on any step of information processing. This would change the runtime behaviour from O(n) to O(n*n/2) on nearly every file system. On Windows NT reading the contents of an directory with 7000 entries and getting full information about every file only takes 0.6 seconds. Specifying the flag osl_FileStatus_Mask_Validate for each entry will increase the time to 180 seconds (!!!).

Typedef Documentation

typedef void* oslDirectory
typedef void* oslDirectoryItem
typedef struct _oslFileStatus oslFileStatus

Structure containing information about files and directories.

See also
osl_getFileStatus()
oslFileType
typedef void* oslVolumeDeviceHandle

Enumeration Type Documentation

Enumerator
osl_File_E_None 

on success

osl_File_E_PERM 

operation not permitted

osl_File_E_NOENT 

no such file or directory

osl_File_E_SRCH 

no process matches the PID

osl_File_E_INTR 

function call was interrupted

osl_File_E_IO 

I/O error occurred

osl_File_E_NXIO 

no such device or address

osl_File_E_2BIG 

argument list too long

osl_File_E_NOEXEC 

invalid executable file format

osl_File_E_BADF 

bad file descriptor

osl_File_E_CHILD 

there are no child processes

osl_File_E_AGAIN 

resource temp unavailable, try again later

osl_File_E_NOMEM 

no memory available

osl_File_E_ACCES 

file permissions do not allow operation

osl_File_E_FAULT 

bad address; an invalid pointer detected

osl_File_E_BUSY 

resource busy

osl_File_E_EXIST 

file exists where should only be created

osl_File_E_XDEV 

improper link across file systems detected

osl_File_E_NODEV 

wrong device type specified

osl_File_E_NOTDIR 

file isn't a directory where one is needed

osl_File_E_ISDIR 

file is a directory, invalid operation

osl_File_E_INVAL 

invalid argument to library function

osl_File_E_NFILE 

too many distinct file openings

osl_File_E_MFILE 

process has too many distinct files open

osl_File_E_NOTTY 

inappropriate I/O control operation

osl_File_E_FBIG 

file too large

osl_File_E_NOSPC 

no space left on device, write failed

osl_File_E_SPIPE 

invalid seek operation (such as on pipe)

osl_File_E_ROFS 

illegal modification to read-only filesystem

osl_File_E_MLINK 

too many links to file

osl_File_E_PIPE 

broken pipe; no process reading from other end of pipe

osl_File_E_DOM 

domain error (mathematical error)

osl_File_E_RANGE 

range error (mathematical error)

osl_File_E_DEADLK 

deadlock avoided

osl_File_E_NAMETOOLONG 

filename too long

osl_File_E_NOLCK 

no locks available

osl_File_E_NOSYS 

function not implemented

osl_File_E_NOTEMPTY 

directory not empty

osl_File_E_LOOP 

too many levels of symbolic links found during name lookup

osl_File_E_ILSEQ 

invalid or incomplete byte sequence of multibyte char found

osl_File_E_NOLINK 

link has been severed

osl_File_E_MULTIHOP 

remote resource is not directly available

osl_File_E_USERS 

file quote system is confused as there are too many users

osl_File_E_OVERFLOW 

value too large for defined data type

osl_File_E_NOTREADY 

device not ready

osl_File_E_invalidError 

unmapped error: always last entry in enum!

osl_File_E_TIMEDOUT 

socket operation timed out

osl_File_E_NETWORK 
osl_File_E_FORCE_EQUAL_SIZE 

Function Documentation

SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem ( oslDirectoryItem  Item)

Increase the refcount of a directory item handle.

The caller responsible for releasing the directory item handle using osl_releaseDirectoryItem().

Parameters
[in]ItemA handle received by a call to osl_getDirectoryItem() or osl_getNextDirectoryItem().
Return values
osl_File_E_Noneon success
osl_File_E_NOMEMnot enough memory for allocating structures
osl_File_E_INVALthe format of the parameters was not valid
See also
osl_getDirectoryItem()
osl_getNextDirectoryItem()
osl_releaseDirectoryItem()
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle ( oslVolumeDeviceHandle  Handle)

Acquire a volume device handle.

Acquires the given oslVolumeDeviceHandle which was acquired by a call to osl_getVolumeInformation(). The caller is responsible for releasing the acquired handle by calling osl_releaseVolumeDeviceHandle().

Parameters
[in]HandleAn oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
Return values
osl_File_E_Noneon success
Todo:
specify all error codes that may be returned
See also
osl_getVolumeInformation()
SAL_DLLPUBLIC oslFileError osl_closeDirectory ( oslDirectory  Directory)

Release a directory handle.

Parameters
[in]DirectoryA handle received by a call to osl_openDirectory().
Return values
osl_File_E_Noneon success
osl_File_E_INVALthe format of the parameters was not valid
osl_File_E_NOMEMnot enough memory for allocating structures
osl_File_E_BADFinvalid oslDirectory parameter
osl_File_E_INTRthe function call was interrupted
See also
osl_openDirectory()
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem ( rtl_uString *  pustrFileURL,
oslDirectoryItem pItem 
)

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.

Parameters
[in]pustrFileURLAn absolute file URL.
[out]pItemOn 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().
Return values
osl_File_E_Noneon success
osl_File_E_INVALthe format of the parameters was not valid
osl_File_E_NOMEMnot enough memory for allocating structures
osl_File_E_ACCESpermission denied
osl_File_E_MFILEtoo many open files used by the process
osl_File_E_NFILEtoo many open files in the system
osl_File_E_NOENTno such file or directory
osl_File_E_LOOPtoo many symbolic links encountered
osl_File_E_NAMETOOLONGthe file name is too long
osl_File_E_NOTDIRa component of the path prefix of path is not a directory
osl_File_E_IOon I/O errors
osl_File_E_MULTIHOPmultihop attempted
osl_File_E_NOLINKlink has been severed
osl_File_E_FAULTbad address
osl_File_E_INTRthe function call was interrupted
See also
osl_releaseDirectoryItem()
osl_acquireDirectoryItem()
osl_getFileStatus()
osl_getNextDirectoryItem()
SAL_DLLPUBLIC oslFileError osl_getFileStatus ( oslDirectoryItem  Item,
oslFileStatus pStatus,
sal_uInt32  uFieldMask 
)

Retrieve information about a single file or directory.

Parameters
[in]ItemA handle received by a previous call to osl_getDirectoryItem() or osl_getNextDirectoryItem().
[in,out]pStatusPoints 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.
[in]uFieldMaskSpecifies which fields of the structure pointed to by pStatus are of interest to the caller.
Return values
osl_File_E_Noneon success
osl_File_E_NOMEMnot enough memory for allocating structures
osl_File_E_INVALthe format of the parameters was not valid
osl_File_E_LOOPtoo many symbolic links encountered
osl_File_E_ACCESpermission denied
osl_File_E_NOENTno such file or directory
osl_File_E_NAMETOOLONGfile name too long
osl_File_E_BADFinvalid oslDirectoryItem parameter
osl_File_E_FAULTbad address
osl_File_E_OVERFLOWvalue too large for defined data type
osl_File_E_INTRfunction call was interrupted
osl_File_E_NOLINKlink has been severed
osl_File_E_MULTIHOPcomponents of path require hopping to multiple remote machines and the file system does not allow it
osl_File_E_MFILEtoo many open files used by the process
osl_File_E_NFILEtoo many open files in the system
osl_File_E_NOSPCno space left on device
osl_File_E_NXIOno such device or address
osl_File_E_IOon I/O errors
osl_File_E_NOSYSfunction not implemented
See also
osl_getDirectoryItem()
osl_getNextDirectoryItem()
oslFileStatus
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem ( oslDirectory  Directory,
oslDirectoryItem pItem,
sal_uInt32  uHint 
)

Retrieve the next item of a previously opened directory.

Retrieves the next item of a previously opened directory. All handles have an initial refcount of 1.

Parameters
[in]DirectoryA directory handle received from a previous call to osl_openDirectory().
[out]pItemOn 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().
[in]uHintWith 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.
Return values
osl_File_E_Noneon success
osl_File_E_INVALthe format of the parameters was not valid
osl_File_E_NOMEMnot enough memory for allocating structures
osl_File_E_NOENTno more entries in this directory
osl_File_E_BADFinvalid oslDirectory parameter
osl_File_E_OVERFLOWthe value too large for defined data type
See also
osl_releaseDirectoryItem()
osl_acquireDirectoryItem()
osl_getDirectoryItem()
osl_getFileStatus()
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath ( oslVolumeDeviceHandle  Handle,
rtl_uString **  ppustrDirectoryURL 
)

Get the full qualified URL where a device is mounted to.

Parameters
[in]HandleAn oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
[out]ppustrDirectoryURLReceives the full qualified URL where the device is mounted to.
Return values
osl_File_E_Noneon success
osl_File_E_NOMEMnot enough memory for allocating structures
osl_File_E_INVALthe format of the parameters was not valid
osl_File_E_ACCESpermission denied
osl_File_E_NXIOno such device or address
osl_File_E_NODEVno such device
osl_File_E_NOENTno such file or directory
osl_File_E_FAULTbad address
osl_FilE_E_INTRfunction call was interrupted
osl_File_E_IOon I/O errors
osl_File_E_MULTIHOPmultihop attempted
osl_File_E_NOLINKlink has been severed
osl_File_E_EOVERFLOWvalue too large for defined data type
See also
osl_getVolumeInformation()
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem ( oslDirectoryItem  pItemA,
oslDirectoryItem  pItemB 
)

Determine if two directory items point 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.

Parameters
[in]pItemAA directory handle to compare with another handle
[in]pItemBA directory handle to compare with pItemA
Return values
sal_Trueif the items point to an identical resource
sal_Falseif the items point to a different resource, or a fatal error occurred
See also
osl_getDirectoryItem()
Since
LibreOffice 3.6
SAL_DLLPUBLIC oslFileError osl_openDirectory ( rtl_uString *  pustrDirectoryURL,
oslDirectory pDirectory 
)

Open a directory for enumerating its contents.

Parameters
[in]pustrDirectoryURLThe full qualified URL of the directory.
[out]pDirectoryOn success it receives a handle used for subsequent calls by osl_getNextDirectoryItem(). The handle has to be released by a call to osl_closeDirectory().
Return values
osl_File_E_Noneon success
osl_File_E_INVALthe format of the parameters was not valid
osl_File_E_NOENTthe specified path doesn't exist
osl_File_E_NOTDIRthe specified path is not an directory
osl_File_E_NOMEMnot enough memory for allocating structures
osl_File_E_ACCESpermission denied
osl_File_E_MFILEtoo many open files used by the process
osl_File_E_NFILEtoo many open files in the system
osl_File_E_NAMETOOLONGFile name too long
osl_File_E_LOOPToo many symbolic links encountered
See also
osl_getNextDirectoryItem()
osl_closeDirectory()
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem ( oslDirectoryItem  Item)

Decrease the refcount of a directory item handle.

Decreases the refcount of a directory item handle. If the refcount reaches 0 the data associated with this directory item handle will be released.

Parameters
[in]ItemA handle received by a call to osl_getDirectoryItem() or osl_getNextDirectoryItem().
Return values
osl_File_E_Noneon success
osl_File_E_NOMEMnot enough memory for allocating structures
osl_File_E_INVALthe format of the parameters was not valid
See also
osl_getDirectoryItem()
osl_getNextDirectoryItem()
osl_acquireDirectoryItem()
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle ( oslVolumeDeviceHandle  Handle)

Release a volume device handle.

Releases the given oslVolumeDeviceHandle which was acquired by a call to osl_getVolumeInformation() or osl_acquireVolumeDeviceHandle().

Parameters
[in]HandleAn oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
Return values
osl_File_E_Noneon success
Todo:
specify all error codes that may be returned
See also
osl_acquireVolumeDeviceHandle()
osl_getVolumeInformation()