20 #ifndef INCLUDED_OSL_FILE_H
21 #define INCLUDED_OSL_FILE_H
168 rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory);
203 oslDirectory Directory,
204 oslDirectoryItem *pItem,
225 oslDirectory Directory);
265 rtl_uString *pustrFileURL,
266 oslDirectoryItem *pItem
288 oslDirectoryItem Item );
311 oslDirectoryItem Item );
334 oslDirectoryItem pItemA,
335 oslDirectoryItem pItemB );
351 #define osl_File_Attribute_ReadOnly 0x00000001
352 #define osl_File_Attribute_Hidden 0x00000002
353 #define osl_File_Attribute_Executable 0x00000010
354 #define osl_File_Attribute_GrpWrite 0x00000020
355 #define osl_File_Attribute_GrpRead 0x00000040
356 #define osl_File_Attribute_GrpExe 0x00000080
357 #define osl_File_Attribute_OwnWrite 0x00000100
358 #define osl_File_Attribute_OwnRead 0x00000200
359 #define osl_File_Attribute_OwnExe 0x00000400
360 #define osl_File_Attribute_OthWrite 0x00000800
361 #define osl_File_Attribute_OthRead 0x00001000
362 #define osl_File_Attribute_OthExe 0x00002000
366 #define osl_FileStatus_Mask_Type 0x00000001
367 #define osl_FileStatus_Mask_Attributes 0x00000002
368 #define osl_FileStatus_Mask_CreationTime 0x00000010
369 #define osl_FileStatus_Mask_AccessTime 0x00000020
370 #define osl_FileStatus_Mask_ModifyTime 0x00000040
371 #define osl_FileStatus_Mask_FileSize 0x00000080
372 #define osl_FileStatus_Mask_FileName 0x00000100
373 #define osl_FileStatus_Mask_FileURL 0x00000200
374 #define osl_FileStatus_Mask_LinkTargetURL 0x00000400
375 #define osl_FileStatus_Mask_All 0x7FFFFFFF
376 #define osl_FileStatus_Mask_Validate 0x80000000
459 oslDirectoryItem Item,
oslFileStatus *pStatus, sal_uInt32 uFieldMask );
483 oslVolumeDeviceHandle Handle );
504 oslVolumeDeviceHandle Handle );
534 oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL);
538 #define osl_Volume_Attribute_Removeable 0x00000001L
539 #define osl_Volume_Attribute_Remote 0x00000002L
540 #define osl_Volume_Attribute_CompactDisc 0x00000004L
541 #define osl_Volume_Attribute_FixedDisk 0x00000008L
542 #define osl_Volume_Attribute_RAMDisk 0x00000010L
543 #define osl_Volume_Attribute_FloppyDisk 0x00000020L
545 #define osl_Volume_Attribute_Case_Is_Preserved 0x00000040L
546 #define osl_Volume_Attribute_Case_Sensitive 0x00000080L
550 #define osl_VolumeInfo_Mask_Attributes 0x00000001L
551 #define osl_VolumeInfo_Mask_TotalSpace 0x00000002L
552 #define osl_VolumeInfo_Mask_UsedSpace 0x00000004L
553 #define osl_VolumeInfo_Mask_FreeSpace 0x00000008L
554 #define osl_VolumeInfo_Mask_MaxNameLength 0x00000010L
555 #define osl_VolumeInfo_Mask_MaxPathLength 0x00000020L
556 #define osl_VolumeInfo_Mask_FileSystemName 0x00000040L
557 #define osl_VolumeInfo_Mask_DeviceHandle 0x00000080L
558 #define osl_VolumeInfo_Mask_FileSystemCaseHandling 0x00000100L
630 rtl_uString *pustrDirectoryURL,
632 sal_uInt32 uFieldMask );
638 #define osl_File_OpenFlag_Read 0x00000001L
639 #define osl_File_OpenFlag_Write 0x00000002L
640 #define osl_File_OpenFlag_Create 0x00000004L
641 #define osl_File_OpenFlag_NoLock 0x00000008L
700 rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags );
702 #define osl_Pos_Absolut 1
703 #define osl_Pos_Current 2
704 #define osl_Pos_End 3
750 oslFileHandle Handle, sal_uInt64 *pPos );
776 oslFileHandle Handle, sal_uInt64 uSize );
801 oslFileHandle Handle, sal_uInt64 *pSize );
808 #define osl_File_MapFlag_RandomAccess ((sal_uInt32)(0x1))
816 #define osl_File_MapFlag_WillNeed ((sal_uInt32)(0x2))
832 oslFileHandle Handle,
874 oslFileHandle Handle,
916 oslFileHandle Handle,
void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead );
945 oslFileHandle Handle,
sal_Bool *pIsEOF );
986 oslFileHandle Handle,
const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten );
995 oslFileHandle Handle,
998 sal_uInt64 uBytesRequested,
999 sal_uInt64* pBytesRead
1010 oslFileHandle Handle,
1012 const void* pBuffer,
1013 sal_uInt64 uBytesToWrite,
1014 sal_uInt64* pBytesWritten
1148 rtl_uString * url, sal_uInt32 flags);
1257 rtl_uString* aDirectoryUrl,
1290 rtl_uString* pustrFileURL );
1320 rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1348 rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1373 rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL);
1412 rtl_uString* pustrBaseDirectoryURL,
1413 rtl_uString *pustrRelativeFileURL,
1414 rtl_uString **ppustrAbsoluteFileURL );
1433 rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL);
1465 rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL );
1484 rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath);
1524 rtl_uString *ustrSystemPath,
1525 rtl_uString **pustrCompacted,
1526 sal_uInt32 uMaxWidth,
1546 rtl_uString *pustrFileURL, sal_uInt64 uAttributes );
1572 rtl_uString *pustrFileURL,
1589 rtl_uString **pustrTempDirURL );
1644 rtl_uString* pustrDirectoryURL,
1645 oslFileHandle* pHandle,
1646 rtl_uString** ppustrTempFileURL);
1652 #endif // INCLUDED_OSL_FILE_H
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Acquire a volume device handle.
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:576
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:572
SAL_DLLPUBLIC oslFileError osl_moveFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Move a file or directory to a new destination or renames it.
SAL_DLLPUBLIC oslFileError osl_copyFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Copy a file to a new destination.
SAL_DLLPUBLIC oslFileError osl_createDirectory(rtl_uString *pustrDirectoryURL)
Create a directory.
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem(oslDirectoryItem pItemA, oslDirectoryItem pItemB)
Determine if two directory items point the same underlying file.
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:389
void * oslFileHandle
Definition: file.h:634
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:582
void * oslDirectory
Definition: file.h:138
unsigned char sal_Bool
Definition: types.h:46
SAL_DLLPUBLIC oslFileError osl_removeFile(rtl_uString *pustrFileURL)
Remove a regular file.
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:587
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_setFilePos(oslFileHandle Handle, sal_uInt32 uHow, sal_Int64 uPos) SAL_WARN_UNUSED_RESULT
Set the internal position pointer of an open file.
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
SAL_DLLPUBLIC oslFileError osl_getCanonicalName(rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
Determine a valid unused canonical name for a requested name.
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:391
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_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
Structure containing information about files and directories.
Definition: file.h:387
struct _oslFileStatus oslFileStatus
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.
sal_uInt64 uAttributes
File attributes.
Definition: file.h:395
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:411
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:405
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:1195
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
#define SAL_WARN_UNUSED_RESULT
Use this as markup for functions and methods whose return value must be checked.
Definition: types.h:307
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:139
sal_uInt32 uMaxPathLength
Maximum length of a full quallified path in system notation.
Definition: file.h:584
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:589
This is the binary specification of a SAL sequence.
Definition: types.h:327
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath(rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
Convert a system dependent path into a file URL.
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:401
oslFileError
Definition: file.h:86
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.
SAL_DLLPUBLIC oslFileError osl_getFileStatus(oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask)
Retrieve information about a single file or directory.
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:574
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:393
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
struct _oslVolumeInfo oslVolumeInfo
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:580
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem(oslDirectoryItem Item)
Decrease the refcount of a directory item handle.
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
void * oslVolumeDeviceHandle
Definition: file.h:462
SAL_DLLPUBLIC oslFileError osl_readFile(oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead)
Read a number of bytes from a file.
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
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_syncFile(oslFileHandle Handle)
Synchronize the memory representation of a file with that on the physical medium. ...
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:403
SAL_DLLPUBLIC oslFileError osl_unmapMappedFile(oslFileHandle Handle, void *pAddr, sal_uInt64 uLength)
Unmap a file segment from memory.
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem(rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
Retrieve a single directory item.
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:578
sal_uInt32(* oslCalcTextWidthFunc)(rtl_uString *ustrText)
Function pointer representing the function called back from osl_abbreviateSystemPath.
Definition: file.h:1499
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:415
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:398
SAL_DLLPUBLIC oslFileError osl_unmapFile(void *pAddr, sal_uInt64 uLength)
Unmap a shared file from memory.
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:408
SAL_DLLPUBLIC oslFileError osl_getFilePos(oslFileHandle Handle, sal_uInt64 *pPos)
Retrieve the current position of the internal pointer of an open file.
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath(oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
Get the full qualified URL where a device is mounted to.
SAL_DLLPUBLIC oslFileError osl_getFileSize(oslFileHandle Handle, sal_uInt64 *pSize)
Get the file size of an open file.
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:570
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
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.
SAL_DLLPUBLIC oslFileError osl_searchFileURL(rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL)
Searche a full qualified system path or a file URL.
SAL_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath(rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
Create a directory path.
SAL_DLLPUBLIC oslFileError osl_getVolumeInformation(rtl_uString *pustrDirectoryURL, oslVolumeInfo *pInfo, sal_uInt32 uFieldMask)
Retrieve information about a volume.
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_DLLPUBLIC oslFileError osl_getNextDirectoryItem(oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
Retrieve the next item of a previously opened directory.
Structure containing information about volumes.
Definition: file.h:568
oslFileType
Definition: file.h:339