LibreOffice
LibreOffice 6.2 SDK C/C++ API Reference
file.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef INCLUDED_OSL_FILE_H
21 #define INCLUDED_OSL_FILE_H
22 
23 #include "sal/config.h"
24 
25 #include "osl/time.h"
26 #include "rtl/ustring.h"
27 #include "sal/saldllapi.h"
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
84 /* Error codes according to errno */
85 typedef enum {
137 } oslFileError;
138 
139 typedef void *oslDirectory;
140 typedef void *oslDirectoryItem;
141 
165 SAL_DLLPUBLIC oslFileError SAL_CALL osl_openDirectory(
166  rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory);
167 
197 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getNextDirectoryItem(
198  oslDirectory Directory,
199  oslDirectoryItem *pItem,
200  sal_uInt32 uHint
201  );
202 
216 SAL_DLLPUBLIC oslFileError SAL_CALL osl_closeDirectory(
217  oslDirectory Directory);
218 
253 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getDirectoryItem(
254  rtl_uString *pustrFileURL,
255  oslDirectoryItem *pItem
256  );
257 
273 SAL_DLLPUBLIC oslFileError SAL_CALL osl_acquireDirectoryItem(
274  oslDirectoryItem Item );
275 
276 
294 SAL_DLLPUBLIC oslFileError SAL_CALL osl_releaseDirectoryItem(
295  oslDirectoryItem Item );
296 
316  oslDirectoryItem pItemA,
317  oslDirectoryItem pItemB );
318 
324 typedef enum {
325  osl_File_Type_Directory, /*< directory */
326  osl_File_Type_Volume, /*< volume (e.g. C:, A:) */
327  osl_File_Type_Regular, /*< regular file */
328  osl_File_Type_Fifo, /*< named pipe */
329  osl_File_Type_Socket, /*< socket */
330  osl_File_Type_Link, /*< file link */
331  osl_File_Type_Special, /*< special device file */
332  osl_File_Type_Unknown /*< unknown file type */
333 } oslFileType;
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
353 
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
371 
378 typedef struct _oslFileStatus {
380  sal_uInt32 uStructSize;
382  sal_uInt32 uValidFields;
384  oslFileType eType;
386  sal_uInt64 uAttributes;
396  sal_uInt64 uFileSize;
399  rtl_uString *ustrFileName;
402  rtl_uString *ustrFileURL;
406  rtl_uString *ustrLinkTargetURL;
407 } oslFileStatus;
408 
447 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileStatus(
448  oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask );
449 
450 typedef void *oslVolumeDeviceHandle;
451 
469 SAL_DLLPUBLIC oslFileError SAL_CALL osl_releaseVolumeDeviceHandle(
470  oslVolumeDeviceHandle Handle );
471 
489 SAL_DLLPUBLIC oslFileError SAL_CALL osl_acquireVolumeDeviceHandle(
490  oslVolumeDeviceHandle Handle );
491 
516 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getVolumeDeviceMountPath(
517  oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL);
518 
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
530 
531 #define osl_Volume_Attribute_Case_Is_Preserved 0x00000040L
532 #define osl_Volume_Attribute_Case_Sensitive 0x00000080L
533 
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
551 
560 typedef struct _oslVolumeInfo {
563  sal_uInt32 uStructSize;
565  sal_uInt32 uValidFields;
567  sal_uInt32 uAttributes;
569  sal_uInt64 uTotalSpace;
571  sal_uInt64 uUsedSpace;
573  sal_uInt64 uFreeSpace;
575  sal_uInt32 uMaxNameLength;
577  sal_uInt32 uMaxPathLength;
581  rtl_uString *ustrFileSystemName;
584  oslVolumeDeviceHandle *pDeviceHandle;
585 } oslVolumeInfo;
586 
621 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getVolumeInformation(
622  rtl_uString *pustrDirectoryURL,
623  oslVolumeInfo *pInfo,
624  sal_uInt32 uFieldMask );
625 
626 typedef void *oslFileHandle;
627 
628 /* Open flags */
629 
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
634 /* larger bit-fields reserved for internal use cf. detail/file.h */
635 
689 SAL_DLLPUBLIC oslFileError SAL_CALL osl_openFile(
690  rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags );
691 
692 #define osl_Pos_Absolut 1
693 #define osl_Pos_Current 2
694 #define osl_Pos_End 3
695 
721  oslFileHandle Handle, sal_uInt32 uHow, sal_Int64 uPos );
722 
741 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFilePos(
742  oslFileHandle Handle, sal_uInt64 *pPos );
743 
765 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileSize(
766  oslFileHandle Handle, sal_uInt64 uSize );
767 
788 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileSize(
789  oslFileHandle Handle, sal_uInt64 *pSize );
790 
797 #define osl_File_MapFlag_RandomAccess ((sal_uInt32)(0x1))
798 
809 #define osl_File_MapFlag_WillNeed ((sal_uInt32)(0x2))
810 
851 SAL_DLLPUBLIC oslFileError SAL_CALL osl_mapFile (
852  oslFileHandle Handle,
853  void** ppAddr,
854  sal_uInt64 uLength,
855  sal_uInt64 uOffset,
856  sal_uInt32 uFlags
857 );
858 
859 
860 #ifndef ANDROID
861 
873 SAL_DLLPUBLIC oslFileError SAL_CALL osl_unmapFile (
874  void* pAddr,
875  sal_uInt64 uLength
876 );
877 
878 #endif
879 
891 SAL_DLLPUBLIC oslFileError SAL_CALL osl_unmapMappedFile (
892  oslFileHandle Handle,
893  void* pAddr,
894  sal_uInt64 uLength
895 );
896 
930 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readFile(
931  oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead );
932 
956 SAL_DLLPUBLIC oslFileError SAL_CALL osl_isEndOfFile(
957  oslFileHandle Handle, sal_Bool *pIsEOF );
958 
994 SAL_DLLPUBLIC oslFileError SAL_CALL osl_writeFile(
995  oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten );
996 
1028 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readFileAt(
1029  oslFileHandle Handle,
1030  sal_uInt64 uOffset,
1031  void* pBuffer,
1032  sal_uInt64 uBytesRequested,
1033  sal_uInt64* pBytesRead
1034 );
1035 
1070 SAL_DLLPUBLIC oslFileError SAL_CALL osl_writeFileAt(
1071  oslFileHandle Handle,
1072  sal_uInt64 uOffset,
1073  const void* pBuffer,
1074  sal_uInt64 uBytesToWrite,
1075  sal_uInt64* pBytesWritten
1076 );
1077 
1103 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readLine(
1104  oslFileHandle Handle, sal_Sequence** ppSequence );
1105 
1127 SAL_DLLPUBLIC oslFileError SAL_CALL osl_syncFile( oslFileHandle Handle );
1128 
1144 SAL_DLLPUBLIC oslFileError SAL_CALL osl_closeFile( oslFileHandle Handle );
1145 
1171 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectory( rtl_uString* pustrDirectoryURL );
1172 
1187 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectoryWithFlags(
1188  rtl_uString * url, sal_uInt32 flags);
1189 
1215 SAL_DLLPUBLIC oslFileError SAL_CALL osl_removeDirectory( rtl_uString* pustrDirectoryURL );
1216 
1232 typedef void (SAL_CALL *oslDirectoryCreationCallbackFunc)(void* pData, rtl_uString* aDirectoryUrl);
1233 
1277 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectoryPath(
1278  rtl_uString* aDirectoryUrl,
1279  oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc,
1280  void* pData);
1281 
1308 SAL_DLLPUBLIC oslFileError SAL_CALL osl_removeFile(
1309  rtl_uString* pustrFileURL );
1310 
1337 SAL_DLLPUBLIC oslFileError SAL_CALL osl_copyFile(
1338  rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1339 
1364 SAL_DLLPUBLIC oslFileError SAL_CALL osl_moveFile(
1365  rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1366 
1386 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getCanonicalName(
1387  rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL);
1388 
1422 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getAbsoluteFileURL(
1423  rtl_uString* pustrBaseDirectoryURL,
1424  rtl_uString *pustrRelativeFileURL,
1425  rtl_uString **ppustrAbsoluteFileURL );
1426 
1440 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileURLFromSystemPath(
1441  rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL);
1442 
1473 SAL_DLLPUBLIC oslFileError SAL_CALL osl_searchFileURL(
1474  rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL );
1475 
1489 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getSystemPathFromFileURL(
1490  rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath);
1491 
1503 typedef sal_uInt32 (SAL_CALL *oslCalcTextWidthFunc)( rtl_uString *ustrText );
1504 
1524 SAL_DLLPUBLIC oslFileError SAL_CALL osl_abbreviateSystemPath(
1525  rtl_uString *ustrSystemPath,
1526  rtl_uString **pustrCompacted,
1527  sal_uInt32 uMaxWidth,
1528  oslCalcTextWidthFunc pCalcWidth );
1529 
1543 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileAttributes(
1544  rtl_uString *pustrFileURL, sal_uInt64 uAttributes );
1545 
1566 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileTime(
1567  rtl_uString *pustrFileURL,
1568  const TimeValue *aCreationTime,
1569  const TimeValue *aLastAccessTime,
1570  const TimeValue *aLastWriteTime);
1571 
1580 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getTempDirURL(
1581  rtl_uString **pustrTempDirURL );
1582 
1632 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createTempFile(
1633  rtl_uString* pustrDirectoryURL,
1634  oslFileHandle* pHandle,
1635  rtl_uString** ppustrTempFileURL);
1636 
1637 #ifdef __cplusplus
1638 }
1639 #endif
1640 
1641 #endif // INCLUDED_OSL_FILE_H
1642 
1643 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:573
Definition: file.h:123
Definition: file.h:111
SAL_DLLPUBLIC oslFileError osl_removeDirectory(rtl_uString *pustrDirectoryURL)
Remove an empty directory.
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:565
Definition: file.h:103
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath(rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
Create a directory path.
Definition: file.h:132
sal_uInt32 uMaxPathLength
Maximum length of a full qualified path in system notation.
Definition: file.h:577
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:575
Definition: file.h:325
Definition: file.h:131
Definition: file.h:93
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:563
Definition: file.h:330
SAL_DLLPUBLIC oslFileError osl_setFileTime(rtl_uString *pustrFileURL, const TimeValue *aCreationTime, const TimeValue *aLastAccessTime, const TimeValue *aLastWriteTime)
Set the file time.
SAL_DLLPUBLIC oslFileError osl_unmapMappedFile(oslFileHandle Handle, void *pAddr, sal_uInt64 uLength)
Unmap a file segment from memory.
Definition: file.h:331
Definition: file.h:120
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath(rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
Convert a system dependent path into a file URL.
Definition: file.h:108
sal_uInt32(* oslCalcTextWidthFunc)(rtl_uString *ustrText)
Function pointer representing the function called back from osl_abbreviateSystemPath.
Definition: file.h:1503
Definition: file.h:136
Definition: file.h:119
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
Definition: file.h:87
Definition: file.h:96
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:380
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:396
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
SAL_DLLPUBLIC oslFileError osl_unmapFile(void *pAddr, sal_uInt64 uLength)
Unmap a shared file from memory.
oslFileType
Definition: file.h:324
Definition: file.h:109
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.
void * oslDirectory
Definition: file.h:139
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
struct _oslVolumeInfo oslVolumeInfo
Structure containing information about volumes.
Definition: file.h:328
Definition: file.h:97
Definition: file.h:327
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:581
Definition: file.h:118
struct _oslFileStatus oslFileStatus
Structure containing information about files and directories.
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.
Definition: file.h:110
Definition: file.h:126
Definition: file.h:86
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
#define SAL_MAX_ENUM
Definition: types.h:223
Definition: file.h:115
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_writeFile(oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten)
Write a number of bytes to a file.
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:567
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:584
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem(oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
Retrieve the next item of a previously opened directory.
Definition: file.h:99
Definition: file.h:121
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.
unsigned char sal_Bool
Definition: types.h:38
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:402
SAL_DLLPUBLIC oslFileError osl_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system&#39;s temporary directory path.
Definition: file.h:107
Definition: file.h:95
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:392
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.
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
SAL_DLLPUBLIC oslFileError osl_getFilePos(oslFileHandle Handle, sal_uInt64 *pPos)
Retrieve the current position of the internal pointer of an open file.
#define SAL_WARN_UNUSED_RESULT
Use this as markup for functions and methods whose return value must be checked.
Definition: types.h:302
Definition: file.h:88
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
Definition: file.h:89
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
Definition: file.h:124
Definition: file.h:122
void * oslDirectoryItem
Definition: file.h:140
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_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:382
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
void * oslVolumeDeviceHandle
Definition: file.h:450
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:406
Definition: file.h:125
Definition: file.h:112
Definition: file.h:102
Definition: file.h:130
sal_uInt64 uAttributes
File attributes.
Definition: file.h:386
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:571
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:384
oslFileError
Definition: file.h:85
SAL_DLLPUBLIC oslFileError osl_getCanonicalName(rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
Determine a valid unused canonical name for a requested name.
Definition: file.h:91
Definition: file.h:128
Definition: file.h:114
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Acquire a volume device handle.
This is the binary specification of a SAL sequence.
Definition: types.h:321
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:394
Definition: file.h:329
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem(oslDirectoryItem Item)
Decrease the refcount of a directory item handle.
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_closeDirectory(oslDirectory Directory)
Release a directory handle.
Definition: time.h:66
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem(oslDirectoryItem pItemA, oslDirectoryItem pItemB)
Determine if two directory items point the same underlying file.
Definition: file.h:92
Definition: file.h:116
void * oslFileHandle
Definition: file.h:626
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_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
Structure containing information about volumes.
Definition: file.h:560
Definition: file.h:90
SAL_DLLPUBLIC oslFileError osl_syncFile(oslFileHandle Handle)
Synchronize the memory representation of a file with that on the physical medium. ...
Definition: file.h:106
Definition: file.h:98
Definition: file.h:127
SAL_DLLPUBLIC oslFileError osl_removeFile(rtl_uString *pustrFileURL)
Remove a regular file.
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem(rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
Retrieve a single directory item.
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:389
Definition: file.h:332
Definition: file.h:101
Definition: file.h:113
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...
Definition: file.h:94
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:399
Definition: file.h:100
Definition: file.h:129
Definition: file.h:104
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:569
Definition: file.h:326
Definition: file.h:133
Definition: file.h:117
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 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.
Structure containing information about files and directories.
Definition: file.h:378
Definition: file.h:105