LibreOffice: osl/file.h Source File

LibreOffice LibreOffice 5.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
86 typedef enum {
87 osl_File_E_None,
88 osl_File_E_PERM,
89 osl_File_E_NOENT,
90 osl_File_E_SRCH,
91 osl_File_E_INTR,
92 osl_File_E_IO,
93 osl_File_E_NXIO,
94 osl_File_E_2BIG,
95 osl_File_E_NOEXEC,
96 osl_File_E_BADF,
97 osl_File_E_CHILD,
98 osl_File_E_AGAIN,
99 osl_File_E_NOMEM,
100 osl_File_E_ACCES,
101 osl_File_E_FAULT,
102 osl_File_E_BUSY,
103 osl_File_E_EXIST,
104 osl_File_E_XDEV,
105 osl_File_E_NODEV,
106 osl_File_E_NOTDIR,
107 osl_File_E_ISDIR,
108 osl_File_E_INVAL,
109 osl_File_E_NFILE,
110 osl_File_E_MFILE,
111 osl_File_E_NOTTY,
112 osl_File_E_FBIG,
113 osl_File_E_NOSPC,
114 osl_File_E_SPIPE,
115 osl_File_E_ROFS,
116 osl_File_E_MLINK,
117 osl_File_E_PIPE,
118 osl_File_E_DOM,
119 osl_File_E_RANGE,
120 osl_File_E_DEADLK,
121 osl_File_E_NAMETOOLONG,
122 osl_File_E_NOLCK,
123 osl_File_E_NOSYS,
124 osl_File_E_NOTEMPTY,
125 osl_File_E_LOOP,
126 osl_File_E_ILSEQ,
127 osl_File_E_NOLINK,
128 osl_File_E_MULTIHOP,
129 osl_File_E_USERS,
130 osl_File_E_OVERFLOW,
131 osl_File_E_NOTREADY,
132 osl_File_E_invalidError, /* unmapped error: always last entry in enum! */
133 osl_File_E_TIMEDOUT,
134 osl_File_E_NETWORK,
135 osl_File_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
136 } oslFileError;
137
138 typedef void *oslDirectory;
139 typedef void *oslDirectoryItem;
140
141
167 SAL_DLLPUBLIC oslFileError SAL_CALL osl_openDirectory(
168 rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory);
169
170
202 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getNextDirectoryItem(
203 oslDirectory Directory,
204 oslDirectoryItem *pItem,
205 sal_uInt32 uHint
206 );
207
208
224 SAL_DLLPUBLIC oslFileError SAL_CALL osl_closeDirectory(
225 oslDirectory Directory);
226
227
264 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getDirectoryItem(
265 rtl_uString *pustrFileURL,
266 oslDirectoryItem *pItem
267 );
268
269
287 SAL_DLLPUBLIC oslFileError SAL_CALL osl_acquireDirectoryItem(
288 oslDirectoryItem Item );
289
290
310 SAL_DLLPUBLIC oslFileError SAL_CALL osl_releaseDirectoryItem(
311 oslDirectoryItem Item );
312
333 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_identicalDirectoryItem(
334 oslDirectoryItem pItemA,
335 oslDirectoryItem pItemB );
336
337 /* File types */
338
339 typedef enum {
340 osl_File_Type_Directory,
341 osl_File_Type_Volume,
342 osl_File_Type_Regular,
343 osl_File_Type_Fifo,
344 osl_File_Type_Socket,
345 osl_File_Type_Link,
346 osl_File_Type_Special,
347 osl_File_Type_Unknown
348 } oslFileType;
349
350 /* File attributes */
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
363
364 /* Flags specifying which fields to retrieve by osl_getFileStatus */
365
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
377
378
379 typedef
380
387 struct _oslFileStatus {
389 sal_uInt32 uStructSize;
391 sal_uInt32 uValidFields;
393 oslFileType eType;
395 sal_uInt64 uAttributes;
398 TimeValue aCreationTime;
401 TimeValue aAccessTime;
403 TimeValue aModifyTime;
405 sal_uInt64 uFileSize;
408 rtl_uString *ustrFileName;
411 rtl_uString *ustrFileURL;
415 rtl_uString *ustrLinkTargetURL;
416 } oslFileStatus;
417
418
458 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileStatus(
459 oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask );
460
461
462 typedef void *oslVolumeDeviceHandle;
463
482 SAL_DLLPUBLIC oslFileError SAL_CALL osl_releaseVolumeDeviceHandle(
483 oslVolumeDeviceHandle Handle );
484
503 SAL_DLLPUBLIC oslFileError SAL_CALL osl_acquireVolumeDeviceHandle(
504 oslVolumeDeviceHandle Handle );
505
506
533 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getVolumeDeviceMountPath(
534 oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL);
535
536 /* Volume attributes */
537
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
544
545 #define osl_Volume_Attribute_Case_Is_Preserved 0x00000040L
546 #define osl_Volume_Attribute_Case_Sensitive 0x00000080L
547
548 /* Flags specifying which fields to retrieve by osl_getVolumeInfo */
549
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
559
560 typedef
561
568 struct _oslVolumeInfo {
570 sal_uInt32 uStructSize;
572 sal_uInt32 uValidFields;
574 sal_uInt32 uAttributes;
576 sal_uInt64 uTotalSpace;
578 sal_uInt64 uUsedSpace;
580 sal_uInt64 uFreeSpace;
582 sal_uInt32 uMaxNameLength;
584 sal_uInt32 uMaxPathLength;
587 rtl_uString *ustrFileSystemName;
589 oslVolumeDeviceHandle *pDeviceHandle;
590 } oslVolumeInfo;
591
592
629 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getVolumeInformation(
630 rtl_uString *pustrDirectoryURL,
631 oslVolumeInfo *pInfo,
632 sal_uInt32 uFieldMask );
633
634 typedef void *oslFileHandle;
635
636 /* Open flags */
637
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
642 /* larger bit-fields reserved for internal use cf. detail/file.h */
643
699 SAL_DLLPUBLIC oslFileError SAL_CALL osl_openFile(
700 rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags );
701
702 #define osl_Pos_Absolut 1
703 #define osl_Pos_Current 2
704 #define osl_Pos_End 3
705
726 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFilePos(
727 oslFileHandle Handle, sal_uInt32 uHow, sal_Int64 uPos ) SAL_WARN_UNUSED_RESULT;
728
729
749 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFilePos(
750 oslFileHandle Handle, sal_uInt64 *pPos );
751
752
775 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileSize(
776 oslFileHandle Handle, sal_uInt64 uSize );
777
778
800 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileSize(
801 oslFileHandle Handle, sal_uInt64 *pSize );
802
803
808 #define osl_File_MapFlag_RandomAccess ((sal_uInt32)(0x1))
809
816 #define osl_File_MapFlag_WillNeed ((sal_uInt32)(0x2))
817
831 SAL_DLLPUBLIC oslFileError SAL_CALL osl_mapFile (
832 oslFileHandle Handle,
833 void** ppAddr,
834 sal_uInt64 uLength,
835 sal_uInt64 uOffset,
836 sal_uInt32 uFlags
837 );
838
839
840 #ifndef ANDROID
841
855 SAL_DLLPUBLIC oslFileError SAL_CALL osl_unmapFile (
856 void* pAddr,
857 sal_uInt64 uLength
858 );
859
860 #endif
861
873 SAL_DLLPUBLIC oslFileError SAL_CALL osl_unmapMappedFile (
874 oslFileHandle Handle,
875 void* pAddr,
876 sal_uInt64 uLength
877 );
878
879
915 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readFile(
916 oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead );
917
918
944 SAL_DLLPUBLIC oslFileError SAL_CALL osl_isEndOfFile(
945 oslFileHandle Handle, sal_Bool *pIsEOF );
946
947
985 SAL_DLLPUBLIC oslFileError SAL_CALL osl_writeFile(
986 oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten );
987
994 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readFileAt(
995 oslFileHandle Handle,
996 sal_uInt64 uOffset,
997 void* pBuffer,
998 sal_uInt64 uBytesRequested,
999 sal_uInt64* pBytesRead
1000 );
1001
1002
1009 SAL_DLLPUBLIC oslFileError SAL_CALL osl_writeFileAt(
1010 oslFileHandle Handle,
1011 sal_uInt64 uOffset,
1012 const void* pBuffer,
1013 sal_uInt64 uBytesToWrite,
1014 sal_uInt64* pBytesWritten
1015 );
1016
1017
1045 SAL_DLLPUBLIC oslFileError SAL_CALL osl_readLine(
1046 oslFileHandle Handle, sal_Sequence** ppSequence );
1047
1082 SAL_DLLPUBLIC oslFileError SAL_CALL osl_syncFile( oslFileHandle Handle );
1083
1101 SAL_DLLPUBLIC oslFileError SAL_CALL osl_closeFile( oslFileHandle Handle );
1102
1103
1131 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectory( rtl_uString* pustrDirectoryURL );
1132
1147 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectoryWithFlags(
1148 rtl_uString * url, sal_uInt32 flags);
1149
1177 SAL_DLLPUBLIC oslFileError SAL_CALL osl_removeDirectory( rtl_uString* pustrDirectoryURL );
1178
1194 typedef void (SAL_CALL *oslDirectoryCreationCallbackFunc)(void* pData, rtl_uString* aDirectoryUrl);
1195
1255 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectoryPath(
1256 rtl_uString* aDirectoryUrl,
1257 oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc,
1258 void* pData);
1259
1288 SAL_DLLPUBLIC oslFileError SAL_CALL osl_removeFile(
1289 rtl_uString* pustrFileURL );
1290
1291
1320 SAL_DLLPUBLIC oslFileError SAL_CALL osl_copyFile(
1321 rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1322
1323
1350 SAL_DLLPUBLIC oslFileError SAL_CALL osl_moveFile(
1351 rtl_uString* pustrSourceFileURL, rtl_uString *pustrDestFileURL );
1352
1353
1375 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getCanonicalName(
1376 rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL);
1377
1378
1414 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getAbsoluteFileURL(
1415 rtl_uString* pustrBaseDirectoryURL,
1416 rtl_uString *pustrRelativeFileURL,
1417 rtl_uString **ppustrAbsoluteFileURL );
1418
1419
1435 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileURLFromSystemPath(
1436 rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL);
1437
1438
1467 SAL_DLLPUBLIC oslFileError SAL_CALL osl_searchFileURL(
1468 rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL );
1469
1470
1486 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getSystemPathFromFileURL(
1487 rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath);
1488
1489
1502 typedef sal_uInt32 (SAL_CALL *oslCalcTextWidthFunc)( rtl_uString *ustrText );
1503
1504
1526 SAL_DLLPUBLIC oslFileError SAL_CALL osl_abbreviateSystemPath(
1527 rtl_uString *ustrSystemPath,
1528 rtl_uString **pustrCompacted,
1529 sal_uInt32 uMaxWidth,
1530 oslCalcTextWidthFunc pCalcWidth );
1531
1532
1548 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileAttributes(
1549 rtl_uString *pustrFileURL, sal_uInt64 uAttributes );
1550
1551
1574 SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileTime(
1575 rtl_uString *pustrFileURL,
1576 const TimeValue *aCreationTime,
1577 const TimeValue *aLastAccessTime,
1578 const TimeValue *aLastWriteTime);
1579
1580
1591 SAL_DLLPUBLIC oslFileError SAL_CALL osl_getTempDirURL(
1592 rtl_uString **pustrTempDirURL );
1593
1594
1646 SAL_DLLPUBLIC oslFileError SAL_CALL osl_createTempFile(
1647 rtl_uString* pustrDirectoryURL,
1648 oslFileHandle* pHandle,
1649 rtl_uString** ppustrTempFileURL);
1650
1651 #ifdef __cplusplus
1652 }
1653 #endif
1654
1655 #endif // INCLUDED_OSL_FILE_H
1656
1657
1658 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
osl_copyFile
SAL_DLLPUBLIC oslFileError osl_copyFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Copy a file to a new destination.
osl_File_Type_Fifo
Definition: file.h:343
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.
_oslFileStatus::uAttributes
sal_uInt64 uAttributes
File attributes.
Definition: file.h:395
osl_closeFile
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
osl_File_E_ACCES
Definition: file.h:100
oslFileHandle
void * oslFileHandle
Definition: file.h:634
osl_File_E_IO
Definition: file.h:92
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.
_oslFileStatus::eType
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:393
osl_File_E_SPIPE
Definition: file.h:114
osl_File_E_FAULT
Definition: file.h:101
osl_openDirectory
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
osl_File_E_NOSPC
Definition: file.h:113
osl_setFileAttributes
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
_oslVolumeInfo::uMaxPathLength
sal_uInt32 uMaxPathLength
Maximum length of a full quallified path in system notation.
Definition: file.h:584
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:96
osl_File_Type_Socket
Definition: file.h:344
osl_getSystemPathFromFileURL
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
TimeValue
Definition: time.h:70
osl_File_Type_Directory
Definition: file.h:340
osl_File_E_ILSEQ
Definition: file.h:126
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
struct _oslVolumeInfo oslVolumeInfo
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
_oslVolumeInfo::uUsedSpace
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:578
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:462
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.
osl_File_Type_Regular
Definition: file.h:342
oslFileStatus
struct _oslFileStatus oslFileStatus
_oslFileStatus::aAccessTime
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:401
osl_File_E_BUSY
Definition: file.h:102
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_E_NOMEM
Definition: file.h:99
_oslFileStatus::uFileSize
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:405
osl_File_E_MULTIHOP
Definition: file.h:128
osl_File_Type_Special
Definition: file.h:346
oslDirectoryItem
void * oslDirectoryItem
Definition: file.h:139
_oslVolumeInfo::uFreeSpace
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:580
osl_acquireDirectoryItem
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
_oslFileStatus::ustrLinkTargetURL
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:415
_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:389
osl_File_E_NOTREADY
Definition: file.h:131
osl_File_E_USERS
Definition: file.h:129
osl_File_E_NFILE
Definition: file.h:109
_oslVolumeInfo::ustrFileSystemName
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:587
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:135
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:1194
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:132
osl_File_E_NOTTY
Definition: file.h:111
osl_File_E_NOTEMPTY
Definition: file.h:124
osl_File_E_OVERFLOW
Definition: file.h:130
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.
_oslVolumeInfo::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:572
osl_createDirectoryWithFlags
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
sal_Bool
unsigned char sal_Bool
Definition: types.h:48
osl_File_E_LOOP
Definition: file.h:125
osl_closeDirectory
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
_oslFileStatus::aCreationTime
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:398
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:104
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_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.
_oslFileStatus
Structure containing information about files and directories.
Definition: file.h:387
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:117
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:88
osl_File_E_DOM
Definition: file.h:118
osl_File_E_ROFS
Definition: file.h:115
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:127
osl_File_E_FBIG
Definition: file.h:112
osl_File_E_NAMETOOLONG
Definition: file.h:121
osl_File_E_NXIO
Definition: file.h:93
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.
_oslVolumeInfo::pDeviceHandle
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:589
_oslVolumeInfo::uAttributes
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:574
_oslFileStatus::ustrFileName
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:408
osl_File_E_EXIST
Definition: file.h:103
osl_File_E_MLINK
Definition: file.h:116
osl_File_E_MFILE
Definition: file.h:110
config.h
_oslFileStatus::aModifyTime
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:403
osl_File_E_ISDIR
Definition: file.h:107
osl_File_E_NODEV
Definition: file.h:105
oslFileError
oslFileError
Definition: file.h:86
osl_File_E_DEADLK
Definition: file.h:120
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:134
osl_File_E_RANGE
Definition: file.h:119
osl_searchFileURL
SAL_DLLPUBLIC oslFileError osl_searchFileURL(rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL)
Searche a full qualified system path or a file URL.
osl_File_Type_Volume
Definition: file.h:341
osl_File_E_TIMEDOUT
Definition: file.h:133
osl_unmapMappedFile
SAL_DLLPUBLIC oslFileError osl_unmapMappedFile(oslFileHandle Handle, void *pAddr, sal_uInt64 uLength)
Unmap a file segment from memory.
_sal_Sequence
This is the binary specification of a SAL sequence.
Definition: types.h:345
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:325
osl_File_E_NOLCK
Definition: file.h:122
_oslVolumeInfo::uMaxNameLength
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:582
osl_File_E_NOEXEC
Definition: file.h:95
oslFileType
oslFileType
Definition: file.h:339
osl_File_E_SRCH
Definition: file.h:90
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:97
osl_File_E_INTR
Definition: file.h:91
osl_File_Type_Link
Definition: file.h:345
_oslFileStatus::ustrFileURL
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:411
oslDirectory
void * oslDirectory
Definition: file.h:138
SAL_MAX_ENUM
#define SAL_MAX_ENUM
Definition: types.h:242
osl_File_Type_Unknown
Definition: file.h:347
oslCalcTextWidthFunc
sal_uInt32(* oslCalcTextWidthFunc)(rtl_uString *ustrText)
Function pointer representing the function called back from osl_abbreviateSystemPath.
Definition: file.h:1502
_oslFileStatus::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:391
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:106
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:89
osl_File_E_AGAIN
Definition: file.h:98
osl_File_E_NOSYS
Definition: file.h:123
osl_File_E_INVAL
Definition: file.h:108
_oslVolumeInfo
Structure containing information about volumes.
Definition: file.h:568
osl_openFile
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
_oslVolumeInfo::uTotalSpace
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:576
osl_File_E_2BIG
Definition: file.h:94
time.h
_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:570
osl_File_E_None
Definition: file.h:87
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.