LibreOffice
LibreOffice 6.4 SDK C/C++ API Reference
|
Go to the documentation of this file.
20 #ifndef INCLUDED_OSL_FILE_H
21 #define INCLUDED_OSL_FILE_H
166 rtl_uString *pustrDirectoryURL,
oslDirectory *pDirectory);
254 rtl_uString *pustrFileURL,
341 #define osl_File_Attribute_ReadOnly 0x00000001
342 #define osl_File_Attribute_Hidden 0x00000002
343 #define osl_File_Attribute_Executable 0x00000010
344 #define osl_File_Attribute_GrpWrite 0x00000020
345 #define osl_File_Attribute_GrpRead 0x00000040
346 #define osl_File_Attribute_GrpExe 0x00000080
347 #define osl_File_Attribute_OwnWrite 0x00000100
348 #define osl_File_Attribute_OwnRead 0x00000200
349 #define osl_File_Attribute_OwnExe 0x00000400
350 #define osl_File_Attribute_OthWrite 0x00000800
351 #define osl_File_Attribute_OthRead 0x00001000
352 #define osl_File_Attribute_OthExe 0x00002000
360 #define osl_FileStatus_Mask_Type 0x00000001
361 #define osl_FileStatus_Mask_Attributes 0x00000002
362 #define osl_FileStatus_Mask_CreationTime 0x00000010
363 #define osl_FileStatus_Mask_AccessTime 0x00000020
364 #define osl_FileStatus_Mask_ModifyTime 0x00000040
365 #define osl_FileStatus_Mask_FileSize 0x00000080
366 #define osl_FileStatus_Mask_FileName 0x00000100
367 #define osl_FileStatus_Mask_FileURL 0x00000200
368 #define osl_FileStatus_Mask_LinkTargetURL 0x00000400
369 #define osl_FileStatus_Mask_All 0x7FFFFFFF
370 #define osl_FileStatus_Mask_Validate 0x80000000
524 #define osl_Volume_Attribute_Removeable 0x00000001L
525 #define osl_Volume_Attribute_Remote 0x00000002L
526 #define osl_Volume_Attribute_CompactDisc 0x00000004L
527 #define osl_Volume_Attribute_FixedDisk 0x00000008L
528 #define osl_Volume_Attribute_RAMDisk 0x00000010L
529 #define osl_Volume_Attribute_FloppyDisk 0x00000020L
531 #define osl_Volume_Attribute_Case_Is_Preserved 0x00000040L
532 #define osl_Volume_Attribute_Case_Sensitive 0x00000080L
542 #define osl_VolumeInfo_Mask_Attributes 0x00000001L
543 #define osl_VolumeInfo_Mask_TotalSpace 0x00000002L
544 #define osl_VolumeInfo_Mask_UsedSpace 0x00000004L
545 #define osl_VolumeInfo_Mask_FreeSpace 0x00000008L
546 #define osl_VolumeInfo_Mask_MaxNameLength 0x00000010L
547 #define osl_VolumeInfo_Mask_MaxPathLength 0x00000020L
548 #define osl_VolumeInfo_Mask_FileSystemName 0x00000040L
549 #define osl_VolumeInfo_Mask_DeviceHandle 0x00000080L
550 #define osl_VolumeInfo_Mask_FileSystemCaseHandling 0x00000100L
622 rtl_uString *pustrDirectoryURL,
624 sal_uInt32 uFieldMask );
630 #define osl_File_OpenFlag_Read 0x00000001L
631 #define osl_File_OpenFlag_Write 0x00000002L
632 #define osl_File_OpenFlag_Create 0x00000004L
633 #define osl_File_OpenFlag_NoLock 0x00000008L
690 rtl_uString *pustrFileURL,
oslFileHandle *pHandle, sal_uInt32 uFlags );
692 #define osl_Pos_Absolut 1
693 #define osl_Pos_Current 2
694 #define osl_Pos_End 3
797 #define osl_File_MapFlag_RandomAccess ((sal_uInt32)(0x1))
809 #define osl_File_MapFlag_WillNeed ((sal_uInt32)(0x2))
931 oslFileHandle Handle,
void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead );
995 oslFileHandle Handle,
const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten );
1032 sal_uInt64 uBytesRequested,
1033 sal_uInt64* pBytesRead
1073 const void* pBuffer,
1074 sal_uInt64 uBytesToWrite,
1075 sal_uInt64* pBytesWritten
1188 rtl_uString * url, sal_uInt32 flags);
1278 rtl_uString* aDirectoryUrl,
1309 rtl_uString* pustrFileURL );
1338 rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1365 rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1387 rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL);
1423 rtl_uString* pustrBaseDirectoryURL,
1424 rtl_uString *pustrRelativeFileURL,
1425 rtl_uString **ppustrAbsoluteFileURL );
1441 rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL);
1474 rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL );
1490 rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath);
1525 rtl_uString *ustrSystemPath,
1526 rtl_uString **pustrCompacted,
1527 sal_uInt32 uMaxWidth,
1544 rtl_uString *pustrFileURL, sal_uInt64 uAttributes );
1567 rtl_uString *pustrFileURL,
1581 rtl_uString **pustrTempDirURL );
1633 rtl_uString* pustrDirectoryURL,
1635 rtl_uString** ppustrTempFileURL);
1666 rtl_uString* pustrDestFileURL);
1672 #endif // INCLUDED_OSL_FILE_H
@ osl_File_E_NXIO
Definition: file.h:92
void * oslFileHandle
Definition: file.h:626
@ osl_File_Type_Fifo
Definition: file.h:328
SAL_DLLPUBLIC oslFileError osl_createDirectory(rtl_uString *pustrDirectoryURL)
Create a directory.
@ osl_File_E_NFILE
Definition: file.h:108
Structure containing information about files and directories.
Definition: file.h:378
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
@ osl_File_E_FORCE_EQUAL_SIZE
Definition: file.h:136
SAL_DLLPUBLIC oslFileError osl_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
sal_uInt32 uMaxPathLength
Maximum length of a full qualified path in system notation.
Definition: file.h:577
@ osl_File_E_invalidError
Definition: file.h:131
void(* oslDirectoryCreationCallbackFunc)(void *pData, rtl_uString *aDirectoryUrl)
Function pointer representing a function that will be called by osl_createDirectoryPath if a director...
Definition: file.h:1232
struct _oslVolumeInfo oslVolumeInfo
Structure containing information about volumes.
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:569
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
@ osl_File_E_ISDIR
Definition: file.h:106
@ osl_File_E_OVERFLOW
Definition: file.h:129
@ osl_File_Type_Special
Definition: file.h:331
@ osl_File_E_NOTEMPTY
Definition: file.h:123
@ osl_File_E_DEADLK
Definition: file.h:119
@ osl_File_E_RANGE
Definition: file.h:118
@ osl_File_E_LOOP
Definition: file.h:124
@ osl_File_E_NETWORK
Definition: file.h:133
@ osl_File_E_NOLCK
Definition: file.h:121
@ osl_File_E_NOEXEC
Definition: file.h:94
SAL_DLLPUBLIC oslFileError osl_readFile(oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead)
Read a number of bytes from a file.
SAL_DLLPUBLIC oslFileError osl_removeFile(rtl_uString *pustrFileURL)
Remove a regular file.
@ osl_File_E_DOM
Definition: file.h:117
@ osl_File_E_ROFS
Definition: file.h:114
oslFileType
Definition: file.h:324
@ osl_File_E_NAMETOOLONG
Definition: file.h:120
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:575
@ osl_File_E_CHILD
Definition: file.h:96
@ osl_File_E_FBIG
Definition: file.h:111
SAL_DLLPUBLIC oslFileError osl_setFileTime(rtl_uString *pustrFileURL, const TimeValue *aCreationTime, const TimeValue *aLastAccessTime, const TimeValue *aLastWriteTime)
Set the file time.
void * oslDirectoryItem
Definition: file.h:140
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:392
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:382
SAL_DLLPUBLIC oslFileError osl_removeDirectory(rtl_uString *pustrDirectoryURL)
Remove an empty directory.
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function.
Definition: file.h:563
SAL_DLLPUBLIC oslFileError osl_moveFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Move a file or directory to a new destination or renames it.
@ osl_File_E_EXIST
Definition: file.h:102
@ osl_File_E_NOENT
Definition: file.h:88
@ osl_File_E_MLINK
Definition: file.h:115
@ osl_File_E_MFILE
Definition: file.h:109
@ osl_File_E_AGAIN
Definition: file.h:97
@ osl_File_E_NODEV
Definition: file.h:104
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:584
SAL_DLLPUBLIC oslFileError osl_getFilePos(oslFileHandle Handle, sal_uInt64 *pPos)
Retrieve the current position of the internal pointer of an open file.
@ osl_File_E_2BIG
Definition: file.h:93
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
@ osl_File_Type_Volume
Definition: file.h:326
SAL_DLLPUBLIC oslFileError osl_getCanonicalName(rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
Determine a valid unused canonical name for a requested name.
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function.
Definition: file.h:380
@ osl_File_E_TIMEDOUT
Definition: file.h:132
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.
unsigned char sal_Bool
Definition: types.h:38
SAL_DLLPUBLIC oslFileError osl_copyFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Copy a file to a new destination.
SAL_DLLPUBLIC oslFileError osl_unmapMappedFile(oslFileHandle Handle, void *pAddr, sal_uInt64 uLength)
Unmap a file segment from memory.
SAL_DLLPUBLIC oslFileError osl_mapFile(oslFileHandle Handle, void **ppAddr, sal_uInt64 uLength, sal_uInt64 uOffset, sal_uInt32 uFlags)
Map a shared file into memory.
sal_uInt64 uAttributes
File attributes.
Definition: file.h:386
@ osl_File_E_IO
Definition: file.h:91
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:406
@ osl_File_E_SRCH
Definition: file.h:89
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
SAL_DLLPUBLIC oslFileError osl_getFileSize(oslFileHandle Handle, sal_uInt64 *pSize)
Get the file size of an open file.
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:389
@ osl_File_Type_Unknown
Definition: file.h:332
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:399
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
@ osl_File_E_INTR
Definition: file.h:90
SAL_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem(oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
Retrieve the next item of a previously opened directory.
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath(rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
Convert a system dependent path into a file URL.
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:396
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:565
@ osl_File_E_NOTDIR
Definition: file.h:105
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem(oslDirectoryItem Item)
Decrease the refcount of a directory item handle.
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem(rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
Retrieve a single directory item.
SAL_DLLPUBLIC oslFileError osl_abbreviateSystemPath(rtl_uString *ustrSystemPath, rtl_uString **pustrCompacted, sal_uInt32 uMaxWidth, oslCalcTextWidthFunc pCalcWidth)
Abbreviate a system notation path.
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Acquire a volume device handle.
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:581
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
@ osl_File_E_NOSYS
Definition: file.h:122
@ osl_File_E_INVAL
Definition: file.h:107
Structure containing information about volumes.
Definition: file.h:560
@ osl_File_E_ILSEQ
Definition: file.h:125
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:571
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:402
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:384
@ osl_File_E_None
Definition: file.h:86
void * oslVolumeDeviceHandle
Definition: file.h:450
SAL_DLLPUBLIC oslFileError osl_unmapFile(void *pAddr, sal_uInt64 uLength)
Unmap a shared file from memory.
@ osl_File_Type_Directory
Definition: file.h:325
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.
@ osl_File_Type_Link
Definition: file.h:330
@ osl_File_E_ACCES
Definition: file.h:99
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
oslFileError
Definition: file.h:85
@ osl_File_E_NOMEM
Definition: file.h:98
SAL_DLLPUBLIC oslFileError osl_writeFile(oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten)
Write a number of bytes to a file.
SAL_DLLPUBLIC oslFileError osl_getVolumeInformation(rtl_uString *pustrDirectoryURL, oslVolumeInfo *pInfo, sal_uInt32 uFieldMask)
Retrieve information about a volume.
#define SAL_WARN_UNUSED_RESULT
Use this as markup for functions and methods whose return value must be checked.
Definition: types.h:302
@ osl_File_E_SPIPE
Definition: file.h:113
@ osl_File_E_FAULT
Definition: file.h:100
@ osl_File_E_NOSPC
Definition: file.h:112
SAL_DLLPUBLIC oslFileError osl_searchFileURL(rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL)
Search a full qualified system path or a file URL.
SAL_WARN_UNUSED_RESULT SAL_DLLPUBLIC oslFileError osl_setFilePos(oslFileHandle Handle, sal_uInt32 uHow, sal_Int64 uPos)
Set the internal position pointer of an open file.
struct _oslFileStatus oslFileStatus
Structure containing information about files and directories.
SAL_DLLPUBLIC oslFileError osl_syncFile(oslFileHandle Handle)
Synchronize the memory representation of a file with that on the physical medium.
#define SAL_MAX_ENUM
Definition: types.h:223
This is the binary specification of a SAL sequence.
Definition: types.h:322
@ osl_File_E_BADF
Definition: file.h:95
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath(rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
Create a directory path.
@ osl_File_E_USERS
Definition: file.h:128
@ osl_File_E_NOTREADY
Definition: file.h:130
void * oslDirectory
Definition: file.h:139
SAL_DLLPUBLIC oslFileError osl_getFileStatus(oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask)
Retrieve information about a single file or directory.
@ osl_File_E_NOTTY
Definition: file.h:110
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath(oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
Get the full qualified URL where a device is mounted to.
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:567
@ osl_File_E_BUSY
Definition: file.h:101
@ osl_File_Type_Regular
Definition: file.h:327
sal_uInt32(* oslCalcTextWidthFunc)(rtl_uString *ustrText)
Function pointer representing the function called back from osl_abbreviateSystemPath.
Definition: file.h:1503
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem(oslDirectoryItem pItemA, oslDirectoryItem pItemB)
Determine if two directory items point the same underlying file.
@ osl_File_E_MULTIHOP
Definition: file.h:127
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:394
@ osl_File_E_XDEV
Definition: file.h:103
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:573
@ osl_File_E_PIPE
Definition: file.h:116
@ osl_File_E_PERM
Definition: file.h:87
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
@ osl_File_E_NOLINK
Definition: file.h:126
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
@ osl_File_Type_Socket
Definition: file.h:329
SAL_DLLPUBLIC oslFileError osl_replaceFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Move a file to a new destination or rename it, taking old file's identity (if exists).
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_get...
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.