LibreOffice: osl/file.h Source File

LibreOffice LibreOffice 6.0 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 {
86 osl_File_E_None,
87 osl_File_E_PERM,
88 osl_File_E_NOENT,
89 osl_File_E_SRCH,
90 osl_File_E_INTR,
91 osl_File_E_IO,
92 osl_File_E_NXIO,
93 osl_File_E_2BIG,
94 osl_File_E_NOEXEC,
95 osl_File_E_BADF,
96 osl_File_E_CHILD,
97 osl_File_E_AGAIN,
98 osl_File_E_NOMEM,
99 osl_File_E_ACCES,
100 osl_File_E_FAULT,
101 osl_File_E_BUSY,
102 osl_File_E_EXIST,
103 osl_File_E_XDEV,
104 osl_File_E_NODEV,
105 osl_File_E_NOTDIR,
106 osl_File_E_ISDIR,
107 osl_File_E_INVAL,
108 osl_File_E_NFILE,
109 osl_File_E_MFILE,
110 osl_File_E_NOTTY,
111 osl_File_E_FBIG,
112 osl_File_E_NOSPC,
113 osl_File_E_SPIPE,
114 osl_File_E_ROFS,
115 osl_File_E_MLINK,
116 osl_File_E_PIPE,
117 osl_File_E_DOM,
118 osl_File_E_RANGE,
119 osl_File_E_DEADLK,
120 osl_File_E_NAMETOOLONG,
121 osl_File_E_NOLCK,
122 osl_File_E_NOSYS,
123 osl_File_E_NOTEMPTY,
124 osl_File_E_LOOP,
125 osl_File_E_ILSEQ,
126 osl_File_E_NOLINK,
127 osl_File_E_MULTIHOP,
128 osl_File_E_USERS,
129 osl_File_E_OVERFLOW,
130 osl_File_E_NOTREADY,
131 osl_File_E_invalidError,
132 osl_File_E_TIMEDOUT,
133 osl_File_E_NETWORK,
134 osl_File_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
135 } oslFileError;
136
137 typedef void *oslDirectory;
138 typedef void *oslDirectoryItem;
139
163 SAL_DLLPUBLIC oslFileError SAL_CALL osl_openDirectory(
164 rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory);
165
195 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getNextDirectoryItem(
196 oslDirectory Directory,
197 oslDirectoryItem *pItem,
198 sal_uInt32 uHint
199 );
200
214 SAL_DLLPUBLIC oslFileError SAL_CALL osl_closeDirectory(
215 oslDirectory Directory);
216
251 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getDirectoryItem(
252 rtl_uString *pustrFileURL,
253 oslDirectoryItem *pItem
254 );
255
271 SAL_DLLPUBLIC oslFileError SAL_CALL osl_acquireDirectoryItem(
272 oslDirectoryItem Item );
273
274
292 SAL_DLLPUBLIC oslFileError SAL_CALL osl_releaseDirectoryItem(
293 oslDirectoryItem Item );
294
313 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_identicalDirectoryItem(
314 oslDirectoryItem pItemA,
315 oslDirectoryItem pItemB );
316
322 typedef enum {
323 osl_File_Type_Directory, /*< directory */
324 osl_File_Type_Volume, /*< volume (e.g. C:, A:) */
325 osl_File_Type_Regular, /*< regular file */
326 osl_File_Type_Fifo, /*< named pipe */
327 osl_File_Type_Socket, /*< socket */
328 osl_File_Type_Link, /*< file link */
329 osl_File_Type_Special, /*< special device file */
330 osl_File_Type_Unknown /*< unknown file type */
331 } oslFileType;
339 #define osl_File_Attribute_ReadOnly 0x00000001
340 #define osl_File_Attribute_Hidden 0x00000002
341 #define osl_File_Attribute_Executable 0x00000010
342 #define osl_File_Attribute_GrpWrite 0x00000020
343 #define osl_File_Attribute_GrpRead 0x00000040
344 #define osl_File_Attribute_GrpExe 0x00000080
345 #define osl_File_Attribute_OwnWrite 0x00000100
346 #define osl_File_Attribute_OwnRead 0x00000200
347 #define osl_File_Attribute_OwnExe 0x00000400
348 #define osl_File_Attribute_OthWrite 0x00000800
349 #define osl_File_Attribute_OthRead 0x00001000
350 #define osl_File_Attribute_OthExe 0x00002000
351
358 #define osl_FileStatus_Mask_Type 0x00000001
359 #define osl_FileStatus_Mask_Attributes 0x00000002
360 #define osl_FileStatus_Mask_CreationTime 0x00000010
361 #define osl_FileStatus_Mask_AccessTime 0x00000020
362 #define osl_FileStatus_Mask_ModifyTime 0x00000040
363 #define osl_FileStatus_Mask_FileSize 0x00000080
364 #define osl_FileStatus_Mask_FileName 0x00000100
365 #define osl_FileStatus_Mask_FileURL 0x00000200
366 #define osl_FileStatus_Mask_LinkTargetURL 0x00000400
367 #define osl_FileStatus_Mask_All 0x7FFFFFFF
368 #define osl_FileStatus_Mask_Validate 0x80000000
369
376 typedef struct _oslFileStatus {
378 sal_uInt32 uStructSize;
380 sal_uInt32 uValidFields;
382 oslFileType eType;
384 sal_uInt64 uAttributes;
387 TimeValue aCreationTime;
390 TimeValue aAccessTime;
392 TimeValue aModifyTime;
394 sal_uInt64 uFileSize;
397 rtl_uString *ustrFileName;
400 rtl_uString *ustrFileURL;
404 rtl_uString *ustrLinkTargetURL;
405 } oslFileStatus;
406
445 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileStatus(
446 oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask );
447
448 typedef void *oslVolumeDeviceHandle;
449
467 SAL_DLLPUBLIC oslFileError SAL_CALL osl_releaseVolumeDeviceHandle(
468 oslVolumeDeviceHandle Handle );
469
487 SAL_DLLPUBLIC oslFileError SAL_CALL osl_acquireVolumeDeviceHandle(
488 oslVolumeDeviceHandle Handle );
489
514 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getVolumeDeviceMountPath(
515 oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL);
516
522 #define osl_Volume_Attribute_Removeable 0x00000001L
523 #define osl_Volume_Attribute_Remote 0x00000002L
524 #define osl_Volume_Attribute_CompactDisc 0x00000004L
525 #define osl_Volume_Attribute_FixedDisk 0x00000008L
526 #define osl_Volume_Attribute_RAMDisk 0x00000010L
527 #define osl_Volume_Attribute_FloppyDisk 0x00000020L
528
529 #define osl_Volume_Attribute_Case_Is_Preserved 0x00000040L
530 #define osl_Volume_Attribute_Case_Sensitive 0x00000080L
531
540 #define osl_VolumeInfo_Mask_Attributes 0x00000001L
541 #define osl_VolumeInfo_Mask_TotalSpace 0x00000002L
542 #define osl_VolumeInfo_Mask_UsedSpace 0x00000004L
543 #define osl_VolumeInfo_Mask_FreeSpace 0x00000008L
544 #define osl_VolumeInfo_Mask_MaxNameLength 0x00000010L
545 #define osl_VolumeInfo_Mask_MaxPathLength 0x00000020L
546 #define osl_VolumeInfo_Mask_FileSystemName 0x00000040L
547 #define osl_VolumeInfo_Mask_DeviceHandle 0x00000080L
548 #define osl_VolumeInfo_Mask_FileSystemCaseHandling 0x00000100L
549
558 typedef struct _oslVolumeInfo {
561 sal_uInt32 uStructSize;
563 sal_uInt32 uValidFields;
565 sal_uInt32 uAttributes;
567 sal_uInt64 uTotalSpace;
569 sal_uInt64 uUsedSpace;
571 sal_uInt64 uFreeSpace;
573 sal_uInt32 uMaxNameLength;
575 sal_uInt32 uMaxPathLength;
579 rtl_uString *ustrFileSystemName;
582 oslVolumeDeviceHandle *pDeviceHandle;
583 } oslVolumeInfo;
584
619 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getVolumeInformation(
620 rtl_uString *pustrDirectoryURL,
621 oslVolumeInfo *pInfo,
622 sal_uInt32 uFieldMask );
623
624 typedef void *oslFileHandle;
625
626 /* Open flags */
627
628 #define osl_File_OpenFlag_Read 0x00000001L
629 #define osl_File_OpenFlag_Write 0x00000002L
630 #define osl_File_OpenFlag_Create 0x00000004L
631 #define osl_File_OpenFlag_NoLock 0x00000008L
632 /* larger bit-fields reserved for internal use cf. detail/file.h */
633
687 SAL_DLLPUBLIC oslFileError SAL_CALL osl_openFile(
688 rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags );
689
690 #define osl_Pos_Absolut 1
691 #define osl_Pos_Current 2
692 #define osl_Pos_End 3
693
718 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFilePos(
719 oslFileHandle Handle, sal_uInt32 uHow, sal_Int64 uPos ) SAL_WARN_UNUSED_RESULT;
720
739 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFilePos(
740 oslFileHandle Handle, sal_uInt64 *pPos );
741
763 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileSize(
764 oslFileHandle Handle, sal_uInt64 uSize );
765
786 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileSize(
787 oslFileHandle Handle, sal_uInt64 *pSize );
788
795 #define osl_File_MapFlag_RandomAccess ((sal_uInt32)(0x1))
796
807 #define osl_File_MapFlag_WillNeed ((sal_uInt32)(0x2))
808
849 SAL_DLLPUBLIC oslFileError SAL_CALL osl_mapFile (
850 oslFileHandle Handle,
851 void** ppAddr,
852 sal_uInt64 uLength,
853 sal_uInt64 uOffset,
854 sal_uInt32 uFlags
855 );
856
857
858 #ifndef ANDROID
859
871 SAL_DLLPUBLIC oslFileError SAL_CALL osl_unmapFile (
872 void* pAddr,
873 sal_uInt64 uLength
874 );
875
876 #endif
877
889 SAL_DLLPUBLIC oslFileError SAL_CALL osl_unmapMappedFile (
890 oslFileHandle Handle,
891 void* pAddr,
892 sal_uInt64 uLength
893 );
894
928 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readFile(
929 oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead );
930
954 SAL_DLLPUBLIC oslFileError SAL_CALL osl_isEndOfFile(
955 oslFileHandle Handle, sal_Bool *pIsEOF );
956
992 SAL_DLLPUBLIC oslFileError SAL_CALL osl_writeFile(
993 oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten );
994
1026 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readFileAt(
1027 oslFileHandle Handle,
1028 sal_uInt64 uOffset,
1029 void* pBuffer,
1030 sal_uInt64 uBytesRequested,
1031 sal_uInt64* pBytesRead
1032 );
1033
1068 SAL_DLLPUBLIC oslFileError SAL_CALL osl_writeFileAt(
1069 oslFileHandle Handle,
1070 sal_uInt64 uOffset,
1071 const void* pBuffer,
1072 sal_uInt64 uBytesToWrite,
1073 sal_uInt64* pBytesWritten
1074 );
1075
1101 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readLine(
1102 oslFileHandle Handle, sal_Sequence** ppSequence );
1103
1125 SAL_DLLPUBLIC oslFileError SAL_CALL osl_syncFile( oslFileHandle Handle );
1126
1142 SAL_DLLPUBLIC oslFileError SAL_CALL osl_closeFile( oslFileHandle Handle );
1143
1169 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectory( rtl_uString* pustrDirectoryURL );
1170
1185 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectoryWithFlags(
1186 rtl_uString * url, sal_uInt32 flags);
1187
1213 SAL_DLLPUBLIC oslFileError SAL_CALL osl_removeDirectory( rtl_uString* pustrDirectoryURL );
1214
1230 typedef void (SAL_CALL *oslDirectoryCreationCallbackFunc)(void* pData, rtl_uString* aDirectoryUrl);
1231
1275 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectoryPath(
1276 rtl_uString* aDirectoryUrl,
1277 oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc,
1278 void* pData);
1279
1306 SAL_DLLPUBLIC oslFileError SAL_CALL osl_removeFile(
1307 rtl_uString* pustrFileURL );
1308
1335 SAL_DLLPUBLIC oslFileError SAL_CALL osl_copyFile(
1336 rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1337
1362 SAL_DLLPUBLIC oslFileError SAL_CALL osl_moveFile(
1363 rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1364
1384 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getCanonicalName(
1385 rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL);
1386
1420 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getAbsoluteFileURL(
1421 rtl_uString* pustrBaseDirectoryURL,
1422 rtl_uString *pustrRelativeFileURL,
1423 rtl_uString **ppustrAbsoluteFileURL );
1424
1438 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileURLFromSystemPath(
1439 rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL);
1440
1471 SAL_DLLPUBLIC oslFileError SAL_CALL osl_searchFileURL(
1472 rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL );
1473
1487 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getSystemPathFromFileURL(
1488 rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath);
1489
1501 typedef sal_uInt32 (SAL_CALL *oslCalcTextWidthFunc)( rtl_uString *ustrText );
1502
1522 SAL_DLLPUBLIC oslFileError SAL_CALL osl_abbreviateSystemPath(
1523 rtl_uString *ustrSystemPath,
1524 rtl_uString **pustrCompacted,
1525 sal_uInt32 uMaxWidth,
1526 oslCalcTextWidthFunc pCalcWidth );
1527
1541 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileAttributes(
1542 rtl_uString *pustrFileURL, sal_uInt64 uAttributes );
1543
1564 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileTime(
1565 rtl_uString *pustrFileURL,
1566 const TimeValue *aCreationTime,
1567 const TimeValue *aLastAccessTime,
1568 const TimeValue *aLastWriteTime);
1569
1578 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getTempDirURL(
1579 rtl_uString **pustrTempDirURL );
1580
1630 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createTempFile(
1631 rtl_uString* pustrDirectoryURL,
1632 oslFileHandle* pHandle,
1633 rtl_uString** ppustrTempFileURL);
1634
1635 #ifdef __cplusplus
1636 }
1637 #endif
1638
1639 #endif // INCLUDED_OSL_FILE_H
1640
1641 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
osl_File_Type_Unknown
Definition: file.h:330
osl_copyFile
SAL_DLLPUBLIC oslFileError osl_copyFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Copy a file to a new destination.
TimeValue
Definition: time.h:66
osl_createTempFile
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...
osl_readFileAt
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.
osl_closeFile
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
osl_File_E_ACCES
Definition: file.h:99
oslFileHandle
void * oslFileHandle
Definition: file.h:624
osl_File_E_IO
Definition: file.h:91
osl_releaseVolumeDeviceHandle
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
osl_createDirectory
SAL_DLLPUBLIC oslFileError osl_createDirectory(rtl_uString *pustrDirectoryURL)
Create a directory.
_oslVolumeInfo::pDeviceHandle
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:582
osl_File_E_SPIPE
Definition: file.h:113
osl_File_E_FAULT
Definition: file.h:100
osl_openDirectory
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
_oslVolumeInfo
Structure containing information about volumes.
Definition: file.h:558
osl_File_E_NOSPC
Definition: file.h:112
osl_setFileAttributes
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
_oslFileStatus::eType
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:382
osl_getVolumeInformation
SAL_DLLPUBLIC oslFileError osl_getVolumeInformation(rtl_uString *pustrDirectoryURL, oslVolumeInfo *pInfo, sal_uInt32 uFieldMask)
Retrieve information about a volume.
osl_acquireVolumeDeviceHandle
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Acquire a volume device handle.
osl_File_E_BADF
Definition: file.h:95
osl_getSystemPathFromFileURL
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
osl_File_E_ILSEQ
Definition: file.h:125
osl_writeFile
SAL_DLLPUBLIC oslFileError osl_writeFile(oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten)
Write a number of bytes to a file.
osl_removeFile
SAL_DLLPUBLIC oslFileError osl_removeFile(rtl_uString *pustrFileURL)
Remove a regular file.
_oslVolumeInfo::uFreeSpace
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:571
oslVolumeInfo
struct _oslVolumeInfo oslVolumeInfo
Structure containing information about volumes.
_oslFileStatus::ustrFileName
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:397
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
osl_getVolumeDeviceMountPath
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath(oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
Get the full qualified URL where a device is mounted to.
oslVolumeDeviceHandle
void * oslVolumeDeviceHandle
Definition: file.h:448
osl_createDirectoryPath
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath(rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
Create a directory path.
osl_setFileTime
SAL_DLLPUBLIC oslFileError osl_setFileTime(rtl_uString *pustrFileURL, const TimeValue *aCreationTime, const TimeValue *aLastAccessTime, const TimeValue *aLastWriteTime)
Set the file time.
_oslFileStatus::ustrLinkTargetURL
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:404
oslFileStatus
struct _oslFileStatus oslFileStatus
Structure containing information about files and directories.
osl_File_E_BUSY
Definition: file.h:101
_oslVolumeInfo::ustrFileSystemName
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:579
osl_getFilePos
SAL_DLLPUBLIC oslFileError osl_getFilePos(oslFileHandle Handle, sal_uInt64 *pPos)
Retrieve the current position of the internal pointer of an open file.
osl_File_Type_Volume
Definition: file.h:324
osl_File_E_NOMEM
Definition: file.h:98
osl_File_E_MULTIHOP
Definition: file.h:127
_oslFileStatus::ustrFileURL
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:400
oslDirectoryItem
void * oslDirectoryItem
Definition: file.h:138
osl_acquireDirectoryItem
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
_oslFileStatus::aAccessTime
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:390
osl_File_Type_Socket
Definition: file.h:327
_oslVolumeInfo::uStructSize
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:561
osl_File_E_NOTREADY
Definition: file.h:130
_oslFileStatus
Structure containing information about files and directories.
Definition: file.h:376
osl_File_E_USERS
Definition: file.h:128
_oslFileStatus::uFileSize
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:394
osl_File_E_NFILE
Definition: file.h:108
osl_setFileSize
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
osl_File_E_FORCE_EQUAL_SIZE
Definition: file.h:134
oslDirectoryCreationCallbackFunc
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:1230
osl_getFileStatus
SAL_DLLPUBLIC oslFileError osl_getFileStatus(oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask)
Retrieve information about a single file or directory.
osl_File_E_invalidError
Definition: file.h:131
osl_File_E_NOTTY
Definition: file.h:110
osl_File_E_NOTEMPTY
Definition: file.h:123
osl_File_E_OVERFLOW
Definition: file.h:129
osl_mapFile
SAL_DLLPUBLIC oslFileError osl_mapFile(oslFileHandle Handle, void **ppAddr, sal_uInt64 uLength, sal_uInt64 uOffset, sal_uInt32 uFlags)
Map a shared file into memory.
osl_createDirectoryWithFlags
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
_oslVolumeInfo::uMaxNameLength
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:573
sal_Bool
unsigned char sal_Bool
Definition: types.h:39
osl_File_E_LOOP
Definition: file.h:124
osl_closeDirectory
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
_oslVolumeInfo::uUsedSpace
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:569
osl_getFileSize
SAL_DLLPUBLIC oslFileError osl_getFileSize(oslFileHandle Handle, sal_uInt64 *pSize)
Get the file size of an open file.
osl_getFileURLFromSystemPath
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath(rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
Convert a system dependent path into a file URL.
saldllapi.h
osl_File_E_XDEV
Definition: file.h:103
ustring.h
osl_getTempDirURL
SAL_DLLPUBLIC oslFileError osl_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system&#39;s temporary directory path.
osl_File_Type_Directory
Definition: file.h:323
osl_readFile
SAL_DLLPUBLIC oslFileError osl_readFile(oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead)
Read a number of bytes from a file.
osl_identicalDirectoryItem
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem(oslDirectoryItem pItemA, oslDirectoryItem pItemB)
Determine if two directory items point the same underlying file.
osl_File_Type_Link
Definition: file.h:328
osl_File_Type_Special
Definition: file.h:329
osl_readLine
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
osl_File_E_PIPE
Definition: file.h:116
osl_getNextDirectoryItem
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem(oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
Retrieve the next item of a previously opened directory.
osl_File_E_PERM
Definition: file.h:87
osl_File_E_DOM
Definition: file.h:117
osl_File_E_ROFS
Definition: file.h:114
_oslVolumeInfo::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:563
osl_abbreviateSystemPath
SAL_DLLPUBLIC oslFileError osl_abbreviateSystemPath(rtl_uString *ustrSystemPath, rtl_uString **pustrCompacted, sal_uInt32 uMaxWidth, oslCalcTextWidthFunc pCalcWidth)
Abbreviate a system notation path.
osl_File_E_NOLINK
Definition: file.h:126
osl_File_E_FBIG
Definition: file.h:111
oslFileType
oslFileType
Definition: file.h:322
osl_File_E_NAMETOOLONG
Definition: file.h:120
osl_File_E_NXIO
Definition: file.h:92
osl_getAbsoluteFileURL
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_Fifo
Definition: file.h:326
osl_File_E_EXIST
Definition: file.h:102
osl_File_E_MLINK
Definition: file.h:115
osl_File_E_MFILE
Definition: file.h:109
config.h
osl_File_Type_Regular
Definition: file.h:325
osl_File_E_ISDIR
Definition: file.h:106
osl_File_E_NODEV
Definition: file.h:104
oslFileError
oslFileError
Definition: file.h:85
osl_File_E_DEADLK
Definition: file.h:119
osl_getCanonicalName
SAL_DLLPUBLIC oslFileError osl_getCanonicalName(rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
Determine a valid unused canonical name for a requested name.
osl_syncFile
SAL_DLLPUBLIC oslFileError osl_syncFile(oslFileHandle Handle)
Synchronize the memory representation of a file with that on the physical medium. ...
osl_File_E_NETWORK
Definition: file.h:133
osl_File_E_RANGE
Definition: file.h:118
osl_searchFileURL
SAL_DLLPUBLIC oslFileError osl_searchFileURL(rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL)
Search a full qualified system path or a file URL.
osl_File_E_TIMEDOUT
Definition: file.h:132
osl_unmapMappedFile
SAL_DLLPUBLIC oslFileError osl_unmapMappedFile(oslFileHandle Handle, void *pAddr, sal_uInt64 uLength)
Unmap a file segment from memory.
SAL_WARN_UNUSED_RESULT
#define SAL_WARN_UNUSED_RESULT
Use this as markup for functions and methods whose return value must be checked.
Definition: types.h:307
osl_File_E_NOLCK
Definition: file.h:121
osl_File_E_NOEXEC
Definition: file.h:94
_oslVolumeInfo::uMaxPathLength
sal_uInt32 uMaxPathLength
Maximum length of a full qualified path in system notation.
Definition: file.h:575
_oslFileStatus::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:380
osl_File_E_SRCH
Definition: file.h:89
_oslVolumeInfo::uAttributes
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:565
_oslVolumeInfo::uTotalSpace
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:567
_oslFileStatus::aModifyTime
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:392
osl_removeDirectory
SAL_DLLPUBLIC oslFileError osl_removeDirectory(rtl_uString *pustrDirectoryURL)
Remove an empty directory.
osl_setFilePos
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.
osl_moveFile
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_CHILD
Definition: file.h:96
osl_File_E_INTR
Definition: file.h:90
oslDirectory
void * oslDirectory
Definition: file.h:137
SAL_MAX_ENUM
#define SAL_MAX_ENUM
Definition: types.h:228
oslCalcTextWidthFunc
sal_uInt32(* oslCalcTextWidthFunc)(rtl_uString *ustrText)
Function pointer representing the function called back from osl_abbreviateSystemPath.
Definition: file.h:1501
osl_releaseDirectoryItem
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem(oslDirectoryItem Item)
Decrease the refcount of a directory item handle.
osl_getDirectoryItem
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem(rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
Retrieve a single directory item.
osl_File_E_NOTDIR
Definition: file.h:105
_sal_Sequence
This is the binary specification of a SAL sequence.
Definition: types.h:327
osl_writeFileAt
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.
osl_File_E_NOENT
Definition: file.h:88
_oslFileStatus::uStructSize
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:378
_oslFileStatus::uAttributes
sal_uInt64 uAttributes
File attributes.
Definition: file.h:384
osl_File_E_AGAIN
Definition: file.h:97
osl_File_E_NOSYS
Definition: file.h:122
osl_File_E_INVAL
Definition: file.h:107
osl_openFile
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
_oslFileStatus::aCreationTime
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:387
osl_File_E_2BIG
Definition: file.h:93
time.h
osl_File_E_None
Definition: file.h:86
osl_unmapFile
SAL_DLLPUBLIC oslFileError osl_unmapFile(void *pAddr, sal_uInt64 uLength)
Unmap a shared file from memory.
osl_isEndOfFile
SAL_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.