LibreOffice: osl/file.hxx Source File

LibreOffice LibreOffice 6.1 SDK C/C++ API Reference

file.hxx
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_HXX
21 #define INCLUDED_OSL_FILE_HXX
22
23 #include "sal/config.h"
24
25 #include <string.h>
26
27 #include <cassert>
28 #include <cstddef>
29
30 #include "sal/log.hxx"
31 #include "osl/time.h"
32 #include "rtl/ustring.hxx"
33
34 #include "osl/file.h"
35 #include "osl/diagnose.h"
36 #include "rtl/byteseq.hxx"
37
38 #include <stdio.h>
39
40 namespace osl
41 {
42
43
51 class FileBase
52 {
53 public:
54
55 enum RC {
56 E_None = osl_File_E_None,
57 E_PERM = osl_File_E_PERM,
58 E_NOENT = osl_File_E_NOENT,
59 E_SRCH = osl_File_E_SRCH,
60 E_INTR = osl_File_E_INTR,
61 E_IO = osl_File_E_IO,
62 E_NXIO = osl_File_E_NXIO,
63 E_2BIG = osl_File_E_2BIG,
64 E_NOEXEC = osl_File_E_NOEXEC,
65 E_BADF = osl_File_E_BADF,
66 E_CHILD = osl_File_E_CHILD,
67 E_AGAIN = osl_File_E_AGAIN,
68 E_NOMEM = osl_File_E_NOMEM,
69 E_ACCES = osl_File_E_ACCES,
70 E_FAULT = osl_File_E_FAULT,
71 E_BUSY = osl_File_E_BUSY,
72 E_EXIST = osl_File_E_EXIST,
73 E_XDEV = osl_File_E_XDEV,
74 E_NODEV = osl_File_E_NODEV,
75 E_NOTDIR = osl_File_E_NOTDIR,
76 E_ISDIR = osl_File_E_ISDIR,
77 E_INVAL = osl_File_E_INVAL,
78 E_NFILE = osl_File_E_NFILE,
79 E_MFILE = osl_File_E_MFILE,
80 E_NOTTY = osl_File_E_NOTTY,
81 E_FBIG = osl_File_E_FBIG,
82 E_NOSPC = osl_File_E_NOSPC,
83 E_SPIPE = osl_File_E_SPIPE,
84 E_ROFS = osl_File_E_ROFS,
85 E_MLINK = osl_File_E_MLINK,
86 E_PIPE = osl_File_E_PIPE,
87 E_DOM = osl_File_E_DOM,
88 E_RANGE = osl_File_E_RANGE,
89 E_DEADLK = osl_File_E_DEADLK,
90 E_NAMETOOLONG = osl_File_E_NAMETOOLONG,
91 E_NOLCK = osl_File_E_NOLCK,
92 E_NOSYS = osl_File_E_NOSYS,
93 E_NOTEMPTY = osl_File_E_NOTEMPTY,
94 E_LOOP = osl_File_E_LOOP,
95 E_ILSEQ = osl_File_E_ILSEQ,
96 E_NOLINK = osl_File_E_NOLINK,
97 E_MULTIHOP = osl_File_E_MULTIHOP,
98 E_USERS = osl_File_E_USERS,
99 E_OVERFLOW = osl_File_E_OVERFLOW,
100 E_NOTREADY = osl_File_E_NOTREADY,
101 E_invalidError = osl_File_E_invalidError,
102 E_TIMEDOUT = osl_File_E_TIMEDOUT,
103 E_NETWORK = osl_File_E_NETWORK
104 };
105
106
107 public:
108
129 static RC getCanonicalName( const ::rtl::OUString& ustrRequestedURL, ::rtl::OUString& ustrValidURL )
130 {
131 return static_cast< RC >( osl_getCanonicalName( ustrRequestedURL.pData, &ustrValidURL.pData ) );
132 }
133
168 static RC getAbsoluteFileURL( const ::rtl::OUString& ustrBaseDirectoryURL, const ::rtl::OUString& ustrRelativeFileURL, ::rtl::OUString& ustrAbsoluteFileURL )
169 {
170 return static_cast< RC >( osl_getAbsoluteFileURL( ustrBaseDirectoryURL.pData, ustrRelativeFileURL.pData, &ustrAbsoluteFileURL.pData ) );
171 }
172
187 static RC getSystemPathFromFileURL( const ::rtl::OUString& ustrFileURL, ::rtl::OUString& ustrSystemPath )
188 {
189 return static_cast< RC >( osl_getSystemPathFromFileURL( ustrFileURL.pData, &ustrSystemPath.pData ) );
190 }
191
206 static RC getFileURLFromSystemPath( const ::rtl::OUString& ustrSystemPath, ::rtl::OUString& ustrFileURL )
207 {
208 return static_cast< RC >( osl_getFileURLFromSystemPath( ustrSystemPath.pData, &ustrFileURL.pData ) );
209 }
210
238 static RC searchFileURL( const ::rtl::OUString& ustrFileName, const ::rtl::OUString& ustrSearchPath, ::rtl::OUString& ustrFileURL )
239 {
240 return static_cast< RC >( osl_searchFileURL( ustrFileName.pData, ustrSearchPath.pData, &ustrFileURL.pData ) );
241 }
242
252 static RC getTempDirURL( ::rtl::OUString& ustrTempDirURL )
253 {
254 return static_cast< RC >( osl_getTempDirURL( &ustrTempDirURL.pData ) );
255 }
256
304 static RC createTempFile(
305 ::rtl::OUString* pustrDirectoryURL,
306 oslFileHandle* pHandle,
307 ::rtl::OUString* pustrTempFileURL)
308 {
309 rtl_uString* pustr_dir_url = pustrDirectoryURL ? pustrDirectoryURL->pData : NULL;
310 rtl_uString** ppustr_tmp_file_url = pustrTempFileURL ? &pustrTempFileURL->pData : NULL;
311
312 return static_cast< RC >( osl_createTempFile(pustr_dir_url, pHandle, ppustr_tmp_file_url) );
313 }
314 };
315
316
322 class VolumeDevice : public FileBase
323 {
324 oslVolumeDeviceHandle _aHandle;
325
326 public:
327
331 VolumeDevice() : _aHandle( NULL )
332 {
333 }
334
341 VolumeDevice( const VolumeDevice & rDevice )
342 {
343 _aHandle = rDevice._aHandle;
344 if ( _aHandle )
345 osl_acquireVolumeDeviceHandle( _aHandle );
346 }
347
351 ~VolumeDevice()
352 {
353 if ( _aHandle )
354 osl_releaseVolumeDeviceHandle( _aHandle );
355 }
356
363 VolumeDevice & operator =( const VolumeDevice & rDevice )
364 {
365 oslVolumeDeviceHandle newHandle = rDevice._aHandle;
366
367 if ( newHandle )
368 osl_acquireVolumeDeviceHandle( newHandle );
369
370 if ( _aHandle )
371 osl_releaseVolumeDeviceHandle( _aHandle );
372
373 _aHandle = newHandle;
374
375 return *this;
376 }
377
383 rtl::OUString getMountPath()
384 {
385 rtl::OUString aPath;
386 osl_getVolumeDeviceMountPath( _aHandle, &aPath.pData );
387 return aPath;
388 }
389
390 friend class VolumeInfo;
391 };
392
393
394 class Directory;
395
404 class VolumeInfo
405 {
406 oslVolumeInfo _aInfo;
407 sal_uInt32 _nMask;
408 VolumeDevice _aDevice;
409
413 VolumeInfo( VolumeInfo& ) SAL_DELETED_FUNCTION;
414
418 VolumeInfo& operator = ( VolumeInfo& ) SAL_DELETED_FUNCTION;
419
420 public:
421
427 VolumeInfo( sal_uInt32 nMask )
428 : _nMask( nMask )
429 {
430 memset( &_aInfo, 0, sizeof( oslVolumeInfo ));
431 _aInfo.uStructSize = sizeof( oslVolumeInfo );
432 _aInfo.pDeviceHandle = &_aDevice._aHandle;
433 }
434
435 ~VolumeInfo()
436 {
437 if( _aInfo.ustrFileSystemName )
438 rtl_uString_release( _aInfo.ustrFileSystemName );
439 }
440
448 bool isValid( sal_uInt32 nMask ) const
449 {
450 return ( nMask & _aInfo.uValidFields ) == nMask;
451 }
452
458 bool getRemoteFlag() const
459 {
460 return (_aInfo.uAttributes & osl_Volume_Attribute_Remote) != 0;
461 }
462
468 bool getRemoveableFlag() const
469 {
470 return (_aInfo.uAttributes & osl_Volume_Attribute_Removeable) != 0;
471 }
472
479 bool getCompactDiscFlag() const
480 {
481 return (_aInfo.uAttributes & osl_Volume_Attribute_CompactDisc) != 0;
482 }
483
490 bool getFloppyDiskFlag() const
491 {
492 return (_aInfo.uAttributes & osl_Volume_Attribute_FloppyDisk) != 0;
493 }
494
501 bool getFixedDiskFlag() const
502 {
503 return (_aInfo.uAttributes & osl_Volume_Attribute_FixedDisk) != 0;
504 }
505
512 bool getRAMDiskFlag() const
513 {
514 return (_aInfo.uAttributes & osl_Volume_Attribute_RAMDisk) != 0;
515 }
516
524 sal_uInt64 getTotalSpace() const
525 {
526 return _aInfo.uTotalSpace;
527 }
528
536 sal_uInt64 getFreeSpace() const
537 {
538 return _aInfo.uFreeSpace;
539 }
540
548 sal_uInt64 getUsedSpace() const
549 {
550 return _aInfo.uUsedSpace;
551 }
552
560 sal_uInt32 getMaxNameLength() const
561 {
562 return _aInfo.uMaxNameLength;
563 }
564
572 sal_uInt32 getMaxPathLength() const
573 {
574 return _aInfo.uMaxPathLength;
575 }
576
584 ::rtl::OUString getFileSystemName() const
585 {
586 return _aInfo.ustrFileSystemName ? ::rtl::OUString( _aInfo.ustrFileSystemName ) : ::rtl::OUString();
587 }
588
589
597 VolumeDevice getDeviceHandle() const
598 {
599 return _aDevice;
600 }
601
608 bool isCaseSensitiveFileSystem() const
609 {
610 return (_aInfo.uAttributes & osl_Volume_Attribute_Case_Sensitive) != 0;
611 }
612
620 bool isCasePreservingFileSystem() const
621 {
622 return (_aInfo.uAttributes & osl_Volume_Attribute_Case_Is_Preserved) != 0;
623 }
624
625 friend class Directory;
626 };
627
628
629 class DirectoryItem;
630
636 class FileStatus
637 {
638 oslFileStatus _aStatus;
639 sal_uInt32 _nMask;
640
644 FileStatus( FileStatus& ) SAL_DELETED_FUNCTION;
645
649 FileStatus& operator = ( FileStatus& ) SAL_DELETED_FUNCTION;
650
651 public:
652
653 enum Type {
654 Directory = osl_File_Type_Directory,
655 Volume = osl_File_Type_Volume,
656 Regular = osl_File_Type_Regular,
657 Fifo = osl_File_Type_Fifo,
658 Socket = osl_File_Type_Socket,
659 Link = osl_File_Type_Link,
660 Special = osl_File_Type_Special,
661 Unknown = osl_File_Type_Unknown
662 };
663
669 FileStatus(sal_uInt32 nMask)
670 : _nMask(nMask)
671 {
672 memset(&_aStatus, 0, sizeof(_aStatus));
673 _aStatus.uStructSize = sizeof(_aStatus);
674 }
675
678 ~FileStatus()
679 {
680 if ( _aStatus.ustrFileURL )
681 rtl_uString_release( _aStatus.ustrFileURL );
682 if ( _aStatus.ustrLinkTargetURL )
683 rtl_uString_release( _aStatus.ustrLinkTargetURL );
684 if ( _aStatus.ustrFileName )
685 rtl_uString_release( _aStatus.ustrFileName );
686 }
687
697 bool isValid( sal_uInt32 nMask ) const
698 {
699 return ( nMask & _aStatus.uValidFields ) == nMask;
700 }
701
707 Type getFileType() const
708 {
709 SAL_INFO_IF(
710 !isValid(osl_FileStatus_Mask_Type), "sal.osl",
711 "no FileStatus Type determined");
712 return isValid(osl_FileStatus_Mask_Type)
713 ? static_cast< Type >(_aStatus.eType) : Unknown;
714 }
715
725 bool isDirectory() const
726 {
727 return ( getFileType() == Directory || getFileType() == Volume );
728 }
729
740 bool isRegular() const
741 {
742 return ( getFileType() == Regular );
743 }
744
753 bool isLink() const
754 {
755 return ( getFileType() == Link );
756 }
757
764 sal_uInt64 getAttributes() const
765 {
766 SAL_INFO_IF(
767 !isValid(osl_FileStatus_Mask_Attributes), "sal.osl",
768 "no FileStatus Attributes determined");
769 return _aStatus.uAttributes;
770 }
771
779 TimeValue getCreationTime() const
780 {
781 SAL_INFO_IF(
782 !isValid(osl_FileStatus_Mask_CreationTime), "sal.osl",
783 "no FileStatus CreationTime determined");
784 return _aStatus.aCreationTime;
785 }
786
794 TimeValue getAccessTime() const
795 {
796 SAL_INFO_IF(
797 !isValid(osl_FileStatus_Mask_AccessTime), "sal.osl",
798 "no FileStatus AccessTime determined");
799 return _aStatus.aAccessTime;
800 }
801
809 TimeValue getModifyTime() const
810 {
811 SAL_INFO_IF(
812 !isValid(osl_FileStatus_Mask_ModifyTime), "sal.osl",
813 "no FileStatus ModifyTime determined");
814 return _aStatus.aModifyTime;
815 }
816
823 sal_uInt64 getFileSize() const
824 {
825 SAL_INFO_IF(
826 !isValid(osl_FileStatus_Mask_FileSize), "sal.osl",
827 "no FileStatus FileSize determined");
828 return _aStatus.uFileSize;
829 }
830
837 ::rtl::OUString getFileName() const
838 {
839 SAL_INFO_IF(
840 !isValid(osl_FileStatus_Mask_FileName), "sal.osl",
841 "no FileStatus FileName determined");
842 return isValid(osl_FileStatus_Mask_FileName)
843 ? rtl::OUString(_aStatus.ustrFileName) : rtl::OUString();
844 }
845
846
854 ::rtl::OUString getFileURL() const
855 {
856 SAL_INFO_IF(
857 !isValid(osl_FileStatus_Mask_FileURL), "sal.osl",
858 "no FileStatus FileURL determined");
859 return isValid(osl_FileStatus_Mask_FileURL)
860 ? rtl::OUString(_aStatus.ustrFileURL) : rtl::OUString();
861 }
862
870 ::rtl::OUString getLinkTargetURL() const
871 {
872 SAL_INFO_IF(
873 !isValid(osl_FileStatus_Mask_LinkTargetURL), "sal.osl",
874 "no FileStatus LinkTargetURL determined");
875 return isValid(osl_FileStatus_Mask_LinkTargetURL)
876 ? rtl::OUString(_aStatus.ustrLinkTargetURL) : rtl::OUString();
877 }
878
879 friend class DirectoryItem;
880 };
881
882
889 class File: public FileBase
890 {
891 oslFileHandle _pData;
892 ::rtl::OUString _aPath;
893
897 File( File& ) SAL_DELETED_FUNCTION;
898
902 File& operator = ( File& ) SAL_DELETED_FUNCTION;
903
904 public:
905
912 File( const ::rtl::OUString& ustrFileURL ): _pData( NULL ), _aPath( ustrFileURL ) {}
913
917 ~File()
918 {
919 close();
920 }
921
929 rtl::OUString getURL() const { return _aPath; }
930
973 RC open( sal_uInt32 uFlags )
974 {
975 return static_cast< RC >( osl_openFile( _aPath.pData, &_pData, uFlags ) );
976 }
977
991 RC close()
992 {
993 oslFileError Error = osl_File_E_BADF;
994
995 if( _pData )
996 {
997 Error=osl_closeFile( _pData );
998 _pData = NULL;
999 }
1000
1001 return static_cast< RC >( Error );
1002 }
1003
1020 RC setPos( sal_uInt32 uHow, sal_Int64 uPos ) SAL_WARN_UNUSED_RESULT
1021 {
1022 return static_cast< RC >( osl_setFilePos( _pData, uHow, uPos ) );
1023 }
1024
1040 RC getPos( sal_uInt64& uPos )
1041 {
1042 return static_cast< RC >( osl_getFilePos( _pData, &uPos ) );
1043 }
1044
1066 RC isEndOfFile( sal_Bool *pIsEOF )
1067 {
1068 return static_cast< RC >( osl_isEndOfFile( _pData, pIsEOF ) );
1069 }
1070
1088 RC setSize( sal_uInt64 uSize )
1089 {
1090 return static_cast< RC >( osl_setFileSize( _pData, uSize ) );
1091 }
1092
1112 RC getSize( sal_uInt64 &rSize )
1113 {
1114 return static_cast< RC >( osl_getFileSize( _pData, &rSize ) );
1115 }
1116
1148 RC read( void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64& rBytesRead )
1149 {
1150 return static_cast< RC >( osl_readFile( _pData, pBuffer, uBytesRequested, &rBytesRead ) );
1151 }
1152
1186 RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64& rBytesWritten)
1187 {
1188 return static_cast< RC >( osl_writeFile( _pData, pBuffer, uBytesToWrite, &rBytesWritten ) );
1189 }
1190
1191
1215 RC readLine( ::rtl::ByteSequence& aSeq )
1216 {
1217 return static_cast< RC >( osl_readLine( _pData, reinterpret_cast<sal_Sequence**>(&aSeq) ) );
1218 }
1219
1239 RC sync() const
1240 {
1241 OSL_PRECOND(_pData, "File::sync(): File not open");
1242 return static_cast< RC >(osl_syncFile(_pData));
1243 }
1244
1270 static RC copy( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1271 {
1272 return static_cast< RC >( osl_copyFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1273 }
1274
1298 static RC move( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1299 {
1300 return static_cast< RC >( osl_moveFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1301 }
1302
1330 static RC replace(const ::rtl::OUString& ustrSourceFileURL,
1331 const ::rtl::OUString& ustrDestFileURL)
1332 {
1333 return static_cast<RC>(osl_replaceFile(ustrSourceFileURL.pData, ustrDestFileURL.pData));
1334 }
1335
1363 static RC remove( const ::rtl::OUString& ustrFileURL )
1364 {
1365 return static_cast< RC >( osl_removeFile( ustrFileURL.pData ) );
1366 }
1367
1383 static RC setAttributes( const ::rtl::OUString& ustrFileURL, sal_uInt64 uAttributes )
1384 {
1385 return static_cast< RC >( osl_setFileAttributes( ustrFileURL.pData, uAttributes ) );
1386 }
1387
1409 static RC setTime(
1410 const ::rtl::OUString& ustrFileURL,
1411 const TimeValue& rCreationTime,
1412 const TimeValue& rLastAccessTime,
1413 const TimeValue& rLastWriteTime )
1414 {
1415 return static_cast< RC >( osl_setFileTime(
1416 ustrFileURL.pData,
1417 &rCreationTime,
1418 &rLastAccessTime,
1419 &rLastWriteTime ) );
1420 }
1421
1422 friend class DirectoryItem;
1423 };
1424
1425
1431 class DirectoryItem: public FileBase
1432 {
1433 oslDirectoryItem _pData;
1434
1435 public:
1436
1440 DirectoryItem(): _pData( NULL )
1441 {
1442 }
1443
1447 DirectoryItem( const DirectoryItem& rItem ): _pData( rItem._pData)
1448 {
1449 if( _pData )
1450 osl_acquireDirectoryItem( _pData );
1451 }
1452
1456 ~DirectoryItem()
1457 {
1458 if( _pData )
1459 osl_releaseDirectoryItem( _pData );
1460 }
1461
1465 DirectoryItem& operator=(const DirectoryItem& rItem )
1466 {
1467 if (&rItem != this)
1468 {
1469 if( _pData )
1470 osl_releaseDirectoryItem( _pData );
1471
1472 _pData = rItem._pData;
1473
1474 if( _pData )
1475 osl_acquireDirectoryItem( _pData );
1476 }
1477 return *this;
1478 }
1479
1486 bool is()
1487 {
1488 return _pData != NULL;
1489 }
1490
1524 static RC get( const ::rtl::OUString& ustrFileURL, DirectoryItem& rItem )
1525 {
1526 if( rItem._pData)
1527 {
1528 osl_releaseDirectoryItem( rItem._pData );
1529 rItem._pData = NULL;
1530 }
1531
1532 return static_cast< RC >( osl_getDirectoryItem( ustrFileURL.pData, &rItem._pData ) );
1533 }
1534
1566 RC getFileStatus( FileStatus& rStatus )
1567 {
1568 return static_cast< RC >( osl_getFileStatus( _pData, &rStatus._aStatus, rStatus._nMask ) );
1569 }
1570
1586 bool isIdenticalTo( const DirectoryItem &pOther )
1587 {
1588 return osl_identicalDirectoryItem( _pData, pOther._pData );
1589 }
1590
1591 friend class Directory;
1592 };
1593
1594
1605 class DirectoryCreationObserver
1606 {
1607 public:
1608 virtual ~DirectoryCreationObserver() {}
1609
1619 virtual void DirectoryCreated(const rtl::OUString& aDirectoryUrl) = 0;
1620 };
1621
1622
1623 // This just an internal helper function for
1624 // private use.
1625 extern "C" inline void SAL_CALL onDirectoryCreated(void* pData, rtl_uString* aDirectoryUrl)
1626 {
1627 static_cast<DirectoryCreationObserver*>(pData)->DirectoryCreated(aDirectoryUrl);
1628 }
1629
1636 class Directory: public FileBase
1637 {
1638 oslDirectory _pData;
1639 ::rtl::OUString _aPath;
1640
1644 Directory( Directory& ) SAL_DELETED_FUNCTION;
1645
1649 Directory& operator = ( Directory& ) SAL_DELETED_FUNCTION;
1650
1651 public:
1652
1660 Directory( const ::rtl::OUString& strPath ): _pData( NULL ), _aPath( strPath )
1661 {
1662 }
1663
1667 ~Directory()
1668 {
1669 close();
1670 }
1671
1679 rtl::OUString getURL() const { return _aPath; }
1680
1698 RC open()
1699 {
1700 return static_cast< RC >( osl_openDirectory( _aPath.pData, &_pData ) );
1701 }
1702
1713 bool isOpen() { return _pData != NULL; }
1714
1726 RC close()
1727 {
1728 oslFileError Error = osl_File_E_BADF;
1729
1730 if( _pData )
1731 {
1732 Error=osl_closeDirectory( _pData );
1733 _pData = NULL;
1734 }
1735
1736 return static_cast< RC >( Error );
1737 }
1738
1739
1756 RC reset()
1757 {
1758 close();
1759 return open();
1760 }
1761
1784 RC getNextItem( DirectoryItem& rItem, sal_uInt32 nHint = 0 )
1785 {
1786 if( rItem._pData )
1787 {
1788 osl_releaseDirectoryItem( rItem._pData );
1789 rItem._pData = NULL;
1790 }
1791 return static_cast<RC>(osl_getNextDirectoryItem( _pData, &rItem._pData, nHint ));
1792 }
1793
1794
1825 static RC getVolumeInfo( const ::rtl::OUString& ustrDirectoryURL, VolumeInfo& rInfo )
1826 {
1827 return static_cast< RC >( osl_getVolumeInformation( ustrDirectoryURL.pData, &rInfo._aInfo, rInfo._nMask ) );
1828 }
1829
1860 static RC create(
1861 const ::rtl::OUString& ustrDirectoryURL,
1862 sal_uInt32 flags = osl_File_OpenFlag_Read | osl_File_OpenFlag_Write )
1863 {
1864 return static_cast< RC >(
1865 osl_createDirectoryWithFlags( ustrDirectoryURL.pData, flags ) );
1866 }
1867
1895 static RC remove( const ::rtl::OUString& ustrDirectoryURL )
1896 {
1897 return static_cast< RC >( osl_removeDirectory( ustrDirectoryURL.pData ) );
1898 }
1899
1936 static RC createPath(
1937 const ::rtl::OUString& aDirectoryUrl,
1938 DirectoryCreationObserver* aDirectoryCreationObserver = NULL)
1939 {
1940 return static_cast< RC >(osl_createDirectoryPath(
1941 aDirectoryUrl.pData,
1942 aDirectoryCreationObserver ? onDirectoryCreated : NULL,
1943 aDirectoryCreationObserver));
1944 }
1945 };
1946
1947 } /* namespace osl */
1948
1949 #endif // INCLUDED_OSL_FILE_HXX
1950
1951 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
osl_File_Type_Unknown
Definition: file.h:332
osl::FileStatus
The FileStatus class.
Definition: file.hxx:636
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::VolumeInfo::getTotalSpace
sal_uInt64 getTotalSpace() const
Determine the total space of a volume device.
Definition: file.hxx:524
osl::FileStatus::getLinkTargetURL
::rtl::OUString getLinkTargetURL() const
Get the link target URL.
Definition: file.hxx:870
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::Directory::create
static RC create(const ::rtl::OUString &ustrDirectoryURL, sal_uInt32 flags=osl_File_OpenFlag_Read|osl_File_OpenFlag_Write)
Create a directory.
Definition: file.hxx:1860
osl::FileStatus::isDirectory
bool isDirectory() const
Is it a directory? This method returns True for both directories, and volumes.
Definition: file.hxx:725
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:626
osl_File_E_IO
Definition: file.h:91
string.h
osl::FileBase::E_NFILE
too many distinct file openings
Definition: file.hxx:78
osl_releaseVolumeDeviceHandle
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
osl::VolumeInfo::isCasePreservingFileSystem
bool isCasePreservingFileSystem() const
Return whether the file system preserves the case of file and directory names or not.
Definition: file.hxx:620
osl::FileBase::E_MULTIHOP
remote resource is not directly available
Definition: file.hxx:97
osl::DirectoryCreationObserver::DirectoryCreated
virtual void DirectoryCreated(const rtl::OUString &aDirectoryUrl)=0
This method will be called when a new directory has been created and needs to be overwritten by deriv...
_oslVolumeInfo::pDeviceHandle
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:584
osl::File::~File
~File()
Destructor.
Definition: file.hxx:917
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.
osl::FileBase::E_INTR
function call was interrupted
Definition: file.hxx:60
_oslVolumeInfo
Structure containing information about volumes.
Definition: file.h:560
osl_FileStatus_Mask_CreationTime
#define osl_FileStatus_Mask_CreationTime
Definition: file.h:362
osl::FileStatus::Special
Definition: file.hxx:660
osl_File_E_NOSPC
Definition: file.h:112
osl_setFileAttributes
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
osl::VolumeInfo::getRemoveableFlag
bool getRemoveableFlag() const
Check the removable flag.
Definition: file.hxx:468
osl::FileStatus::getFileURL
::rtl::OUString getFileURL() const
Get the URL of the file.
Definition: file.hxx:854
osl::DirectoryItem
The directory item class object provides access to file status information.
Definition: file.hxx:1431
osl::FileStatus::getFileName
::rtl::OUString getFileName() const
Get the file name.
Definition: file.hxx:837
rtl::ByteSequence
C++ class representing a SAL byte sequence.
Definition: byteseq.h:166
osl::FileBase::E_NOENT
no such file or directory
Definition: file.hxx:58
osl::FileBase::E_2BIG
argument list too long
Definition: file.hxx:63
osl::FileStatus::isValid
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:697
osl::VolumeInfo
The VolumeInfo class.
Definition: file.hxx:404
_oslFileStatus::eType
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:384
osl_Volume_Attribute_Removeable
#define osl_Volume_Attribute_Removeable
Definition: file.h:524
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::FileBase::E_FAULT
bad address; an invalid pointer detected
Definition: file.hxx:70
osl::DirectoryItem::DirectoryItem
DirectoryItem(const DirectoryItem &rItem)
Copy constructor.
Definition: file.hxx:1447
osl::FileStatus::getCreationTime
TimeValue getCreationTime() const
Get the creation time of this file.
Definition: file.hxx:779
osl_getSystemPathFromFileURL
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
osl::VolumeInfo::getFloppyDiskFlag
bool getFloppyDiskFlag() const
Check the floppy disc flag.
Definition: file.hxx:490
osl::File::move
static RC move(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Move a file or directory to a new destination or renames it.
Definition: file.hxx:1298
osl_File_E_ILSEQ
Definition: file.h:125
osl::FileBase::E_EXIST
file exists where should only be created
Definition: file.hxx:72
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.
osl::VolumeInfo::getMaxNameLength
sal_uInt32 getMaxNameLength() const
Determine the maximal length of a file name.
Definition: file.hxx:560
osl::VolumeInfo::getRAMDiskFlag
bool getRAMDiskFlag() const
Check the RAM disk flag.
Definition: file.hxx:512
_oslVolumeInfo::uFreeSpace
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:573
oslVolumeInfo
struct _oslVolumeInfo oslVolumeInfo
Structure containing information about volumes.
osl::FileBase::E_INVAL
invalid argument to library function
Definition: file.hxx:77
_oslFileStatus::ustrFileName
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:399
osl::FileBase::E_MLINK
too many links to file
Definition: file.hxx:85
osl_getVolumeDeviceMountPath
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath(oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
Get the full qualified URL where a device is mounted to.
osl::Directory
The directory class object provides a enumeration of DirectoryItems.
Definition: file.hxx:1636
oslVolumeDeviceHandle
void * oslVolumeDeviceHandle
Definition: file.h:450
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::DirectoryItem::operator=
DirectoryItem & operator=(const DirectoryItem &rItem)
Assignment operator.
Definition: file.hxx:1465
osl::VolumeDevice::VolumeDevice
VolumeDevice(const VolumeDevice &rDevice)
Copy constructor.
Definition: file.hxx:341
_oslFileStatus::ustrLinkTargetURL
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:406
osl::File::setTime
static RC setTime(const ::rtl::OUString &ustrFileURL, const TimeValue &rCreationTime, const TimeValue &rLastAccessTime, const TimeValue &rLastWriteTime)
Set the file time.
Definition: file.hxx:1409
osl_File_E_BUSY
Definition: file.h:101
osl::onDirectoryCreated
void onDirectoryCreated(void *pData, rtl_uString *aDirectoryUrl)
Definition: file.hxx:1625
_oslVolumeInfo::ustrFileSystemName
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:581
osl::DirectoryItem::isIdenticalTo
bool isIdenticalTo(const DirectoryItem &pOther)
Determine if a directory item point the same underlying file.
Definition: file.hxx:1586
osl::FileBase::getTempDirURL
static RC getTempDirURL(::rtl::OUString &ustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
Definition: file.hxx:252
osl::Socket
Definition: socket_decl.hxx:191
osl::File::readLine
RC readLine(::rtl::ByteSequence &aSeq)
Read a line from a file.
Definition: file.hxx:1215
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:326
osl::VolumeInfo::isCaseSensitiveFileSystem
bool isCaseSensitiveFileSystem() const
Return whether the file system is case sensitive or case insensitive.
Definition: file.hxx:608
SAL_DELETED_FUNCTION
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:394
osl::FileBase::E_DEADLK
deadlock avoided
Definition: file.hxx:89
osl_File_E_NOMEM
Definition: file.h:98
osl::FileStatus::getAttributes
sal_uInt64 getAttributes() const
Get the file attributes.
Definition: file.hxx:764
osl::VolumeInfo::getCompactDiscFlag
bool getCompactDiscFlag() const
Check the compact disc flag.
Definition: file.hxx:479
osl_File_E_MULTIHOP
Definition: file.h:127
osl::FileBase::E_SPIPE
invalid seek operation (such as on pipe)
Definition: file.hxx:83
_oslFileStatus::ustrFileURL
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:402
oslDirectoryItem
void * oslDirectoryItem
Definition: file.h:140
osl_FileStatus_Mask_FileSize
#define osl_FileStatus_Mask_FileSize
Definition: file.h:365
osl::FileBase::RC
RC
Definition: file.hxx:55
file.h
Main goals and usage hints.
osl::FileBase::E_USERS
file quote system is confused as there are too many users
Definition: file.hxx:98
osl_acquireDirectoryItem
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
osl_FileStatus_Mask_FileName
#define osl_FileStatus_Mask_FileName
Definition: file.h:366
_oslFileStatus::aAccessTime
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:392
osl_File_Type_Socket
Definition: file.h:329
osl::FileBase::E_NOTREADY
device not ready
Definition: file.hxx:100
osl::FileBase::createTempFile
static RC createTempFile(::rtl::OUString *pustrDirectoryURL, oslFileHandle *pHandle, ::rtl::OUString *pustrTempFileURL)
Creates a temporary file in the directory provided by the caller or the directory returned by getTemp...
Definition: file.hxx:304
osl::VolumeInfo::VolumeInfo
VolumeInfo(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:427
_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:563
osl_FileStatus_Mask_FileURL
#define osl_FileStatus_Mask_FileURL
Definition: file.h:367
osl::Directory::getVolumeInfo
static RC getVolumeInfo(const ::rtl::OUString &ustrDirectoryURL, VolumeInfo &rInfo)
Retrieve information about a volume.
Definition: file.hxx:1825
osl::VolumeDevice
The VolumeDevice class.
Definition: file.hxx:322
osl_File_E_NOTREADY
Definition: file.h:130
osl::FileBase::E_LOOP
too many levels of symbolic links found during name lookup
Definition: file.hxx:94
_oslFileStatus
Structure containing information about files and directories.
Definition: file.h:378
osl::FileStatus::~FileStatus
~FileStatus()
Destructor.
Definition: file.hxx:678
osl_File_E_USERS
Definition: file.h:128
_oslFileStatus::uFileSize
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:396
osl::FileBase::getCanonicalName
static RC getCanonicalName(const ::rtl::OUString &ustrRequestedURL, ::rtl::OUString &ustrValidURL)
Determine a valid unused canonical name for a requested name.
Definition: file.hxx:129
osl::FileStatus::getFileType
Type getFileType() const
Get the file type.
Definition: file.hxx:707
osl::FileBase::E_SRCH
no process matches the PID
Definition: file.hxx:59
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:121
osl::VolumeInfo::getUsedSpace
sal_uInt64 getUsedSpace() const
Determine the used space of a volume device.
Definition: file.hxx:548
osl_File_E_NFILE
Definition: file.h:108
osl::FileBase::getSystemPathFromFileURL
static RC getSystemPathFromFileURL(const ::rtl::OUString &ustrFileURL, ::rtl::OUString &ustrSystemPath)
Convert a file URL into a system dependent path.
Definition: file.hxx:187
osl_setFileSize
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
osl
Definition: conditn.hxx:36
osl::VolumeInfo::isValid
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:448
osl::Directory::~Directory
~Directory()
Destructor.
Definition: file.hxx:1667
osl::FileBase::E_IO
I/O error occurred.
Definition: file.hxx:61
osl::File::close
RC close()
Close an open file.
Definition: file.hxx:991
ustring.hxx
osl::FileBase::E_NOSPC
no space left on device, write failed
Definition: file.hxx:82
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::Directory::getNextItem
RC getNextItem(DirectoryItem &rItem, sal_uInt32 nHint=0)
Retrieve the next item of a previously opened directory.
Definition: file.hxx:1784
osl_File_E_NOTTY
Definition: file.h:110
osl::FileStatus::getModifyTime
TimeValue getModifyTime() const
Get the file modification time.
Definition: file.hxx:809
osl_Volume_Attribute_RAMDisk
#define osl_Volume_Attribute_RAMDisk
Definition: file.h:528
osl_File_E_NOTEMPTY
Definition: file.h:123
osl::File::getURL
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:929
osl_File_E_OVERFLOW
Definition: file.h:129
osl_createDirectoryWithFlags
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
osl::FileBase::E_ILSEQ
invalid or incomplete byte sequence of multibyte char found
Definition: file.hxx:95
_oslVolumeInfo::uMaxNameLength
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:575
osl::File::read
RC read(void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 &rBytesRead)
Read a number of bytes from a file.
Definition: file.hxx:1148
sal_Bool
unsigned char sal_Bool
Definition: types.h:38
osl_File_E_LOOP
Definition: file.h:124
osl_closeDirectory
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
osl::FileBase::E_RANGE
range error (mathematical error)
Definition: file.hxx:88
osl::FileBase
Base class for all File System specific objects.
Definition: file.hxx:51
_oslVolumeInfo::uUsedSpace
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:571
osl::FileBase::E_PERM
operation not permitted
Definition: file.hxx:57
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.
osl::File::setPos
RC setPos(sal_uInt32 uHow, sal_Int64 uPos) SAL_WARN_UNUSED_RESULT
Set the internal position pointer of an open file.
Definition: file.hxx:1020
osl_File_E_XDEV
Definition: file.h:103
osl::Directory::isOpen
bool isOpen()
Query if directory is open.
Definition: file.hxx:1713
osl::VolumeDevice::~VolumeDevice
~VolumeDevice()
Destructor.
Definition: file.hxx:351
osl::VolumeInfo::getFixedDiskFlag
bool getFixedDiskFlag() const
Check the fixed disk flag.
Definition: file.hxx:501
osl::FileStatus::Regular
Definition: file.hxx:656
osl::File::replace
static RC replace(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Move a file to a new destination or rename it, taking old file's identity (if exists).
Definition: file.hxx:1330
osl_getTempDirURL
SAL_DLLPUBLIC oslFileError osl_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
osl_File_Type_Directory
Definition: file.h:325
osl_Volume_Attribute_Remote
#define osl_Volume_Attribute_Remote
Definition: file.h:525
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::FileStatus::Link
Definition: file.hxx:659
log.hxx
osl_FileStatus_Mask_LinkTargetURL
#define osl_FileStatus_Mask_LinkTargetURL
Definition: file.h:368
osl_File_Type_Link
Definition: file.h:330
osl_File_Type_Special
Definition: file.h:331
osl_readLine
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
osl::FileBase::E_NOTTY
inappropriate I/O control operation
Definition: file.hxx:80
osl_File_E_PIPE
Definition: file.h:116
osl::FileBase::E_NAMETOOLONG
filename too long
Definition: file.hxx:90
osl::FileBase::E_ACCES
file permissions do not allow operation
Definition: file.hxx:69
osl::FileStatus::Unknown
Definition: file.hxx:661
osl::File::copy
static RC copy(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Copy a file to a new destination.
Definition: file.hxx:1270
osl_getNextDirectoryItem
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem(oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
Retrieve the next item of a previously opened directory.
osl_FileStatus_Mask_ModifyTime
#define osl_FileStatus_Mask_ModifyTime
Definition: file.h:364
osl_File_E_PERM
Definition: file.h:87
osl::FileBase::E_CHILD
there are no child processes
Definition: file.hxx:66
osl_File_E_DOM
Definition: file.h:117
osl::Directory::createPath
static RC createPath(const ::rtl::OUString &aDirectoryUrl, DirectoryCreationObserver *aDirectoryCreationObserver=NULL)
Create a directory path.
Definition: file.hxx:1936
osl_File_E_ROFS
Definition: file.h:114
osl::FileBase::E_NOTDIR
file isn't a directory where one is needed
Definition: file.hxx:75
_oslVolumeInfo::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:565
osl_File_OpenFlag_Read
#define osl_File_OpenFlag_Read
Definition: file.h:630
osl_File_E_NOLINK
Definition: file.h:126
osl_File_E_FBIG
Definition: file.h:111
osl_File_E_NAMETOOLONG
Definition: file.h:120
osl::FileBase::E_NOLINK
link has been severed
Definition: file.hxx:96
osl::FileBase::E_NODEV
wrong device type specified
Definition: file.hxx:74
osl_File_E_NXIO
Definition: file.h:92
osl::DirectoryCreationObserver::~DirectoryCreationObserver
virtual ~DirectoryCreationObserver()
Definition: file.hxx:1608
osl::File::setAttributes
static RC setAttributes(const ::rtl::OUString &ustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
Definition: file.hxx:1383
osl::FileBase::E_None
on success
Definition: file.hxx:56
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::isEndOfFile
RC isEndOfFile(sal_Bool *pIsEOF)
Test if the end of a file is reached.
Definition: file.hxx:1066
osl::FileStatus::isLink
bool isLink() const
Is it a link?
Definition: file.hxx:753
osl::FileBase::E_NOTEMPTY
directory not empty
Definition: file.hxx:93
osl::Directory::open
RC open()
Open a directory for enumerating its contents.
Definition: file.hxx:1698
osl::VolumeInfo::getRemoteFlag
bool getRemoteFlag() const
Check the remote flag.
Definition: file.hxx:458
osl::FileBase::E_NETWORK
Definition: file.hxx:103
osl_File_Type_Fifo
Definition: file.h:328
osl::Directory::getURL
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:1679
osl_FileStatus_Mask_AccessTime
#define osl_FileStatus_Mask_AccessTime
Definition: file.h:363
osl::VolumeDevice::getMountPath
rtl::OUString getMountPath()
Get the full qualified URL where a device is mounted to.
Definition: file.hxx:383
osl::FileStatus::Volume
Definition: file.hxx:655
osl_File_E_EXIST
Definition: file.h:102
osl_File_E_MLINK
Definition: file.h:115
osl::VolumeInfo::~VolumeInfo
~VolumeInfo()
Definition: file.hxx:435
osl_File_E_MFILE
Definition: file.h:109
osl::FileBase::searchFileURL
static RC searchFileURL(const ::rtl::OUString &ustrFileName, const ::rtl::OUString &ustrSearchPath, ::rtl::OUString &ustrFileURL)
Searche a full qualified system path or a file URL.
Definition: file.hxx:238
osl_File_OpenFlag_Write
#define osl_File_OpenFlag_Write
Definition: file.h:631
osl_FileStatus_Mask_Attributes
#define osl_FileStatus_Mask_Attributes
Definition: file.h:361
osl::File::sync
RC sync() const
Synchronize the memory representation of a file with that on the physical medium.
Definition: file.hxx:1239
osl::FileBase::getFileURLFromSystemPath
static RC getFileURLFromSystemPath(const ::rtl::OUString &ustrSystemPath, ::rtl::OUString &ustrFileURL)
Convert a system dependent path into a file URL.
Definition: file.hxx:206
config.h
osl_File_Type_Regular
Definition: file.h:327
osl::File::setSize
RC setSize(sal_uInt64 uSize)
Set the file size of an open file.
Definition: file.hxx:1088
osl::Directory::Directory
Directory(const ::rtl::OUString &strPath)
Constructor.
Definition: file.hxx:1660
osl::DirectoryItem::is
bool is()
Check for validity of this instance.
Definition: file.hxx:1486
osl::File
The file class object provides access to file contents and attributes.
Definition: file.hxx:889
osl_Volume_Attribute_Case_Sensitive
#define osl_Volume_Attribute_Case_Sensitive
Definition: file.h:532
osl::FileBase::E_NOSYS
function not implemented
Definition: file.hxx:92
osl_File_E_ISDIR
Definition: file.h:106
osl_FileStatus_Mask_Type
#define osl_FileStatus_Mask_Type
Definition: file.h:360
osl::DirectoryItem::~DirectoryItem
~DirectoryItem()
Destructor.
Definition: file.hxx:1456
osl_File_E_NODEV
Definition: file.h:104
osl::FileBase::E_NXIO
no such device or address
Definition: file.hxx:62
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::FileBase::E_AGAIN
resource temp unavailable, try again later
Definition: file.hxx:67
osl::File::File
File(const ::rtl::OUString &ustrFileURL)
Constructor.
Definition: file.hxx:912
osl::FileBase::E_OVERFLOW
value too large for defined data type
Definition: file.hxx:99
osl::FileBase::E_FBIG
file too large
Definition: file.hxx:81
osl_File_E_TIMEDOUT
Definition: file.h:132
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:300
osl_Volume_Attribute_CompactDisc
#define osl_Volume_Attribute_CompactDisc
Definition: file.h:526
SAL_INFO_IF
#define SAL_INFO_IF(condition, area, stream)
Produce log entry from stream in the given log area if condition is true.
Definition: log.hxx:313
osl_File_E_NOLCK
Definition: file.h:121
osl::FileBase::E_BUSY
resource busy
Definition: file.hxx:71
osl::DirectoryItem::DirectoryItem
DirectoryItem()
Constructor.
Definition: file.hxx:1440
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:577
osl::File::write
RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 &rBytesWritten)
Write a number of bytes to a file.
Definition: file.hxx:1186
_oslFileStatus::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:382
osl_File_E_SRCH
Definition: file.h:89
osl_Volume_Attribute_Case_Is_Preserved
#define osl_Volume_Attribute_Case_Is_Preserved
Definition: file.h:531
_oslVolumeInfo::uAttributes
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:567
_oslVolumeInfo::uTotalSpace
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:569
_oslFileStatus::aModifyTime
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:394
osl::FileBase::E_invalidError
unmapped error: always last entry in enum!
Definition: file.hxx:101
osl::FileBase::E_TIMEDOUT
socket operation timed out
Definition: file.hxx:102
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::FileBase::E_NOLCK
no locks available
Definition: file.hxx:91
osl_File_E_CHILD
Definition: file.h:96
byteseq.hxx
osl::FileStatus::Type
Type
Definition: file.hxx:653
osl::FileBase::getAbsoluteFileURL
static RC getAbsoluteFileURL(const ::rtl::OUString &ustrBaseDirectoryURL, const ::rtl::OUString &ustrRelativeFileURL, ::rtl::OUString &ustrAbsoluteFileURL)
Convert a path relative to a given directory into an full qualified file URL.
Definition: file.hxx:168
osl::FileBase::E_ISDIR
file is a directory, invalid operation
Definition: file.hxx:76
osl::FileStatus::FileStatus
FileStatus(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:669
osl::FileBase::E_BADF
bad file descriptor
Definition: file.hxx:65
osl::File::getSize
RC getSize(sal_uInt64 &rSize)
Get the file size of an open file.
Definition: file.hxx:1112
osl_File_E_INTR
Definition: file.h:90
osl::FileBase::E_XDEV
improper link across file systems detected
Definition: file.hxx:73
osl::VolumeDevice::operator=
VolumeDevice & operator=(const VolumeDevice &rDevice)
Assignment operator.
Definition: file.hxx:363
osl::DirectoryItem::get
static RC get(const ::rtl::OUString &ustrFileURL, DirectoryItem &rItem)
Retrieve a single directory item.
Definition: file.hxx:1524
osl::FileBase::E_NOEXEC
invalid executable file format
Definition: file.hxx:64
osl::FileBase::E_DOM
domain error (mathematical error)
Definition: file.hxx:87
osl::FileBase::E_ROFS
illegal modification to read-only filesystem
Definition: file.hxx:84
osl::VolumeInfo::getDeviceHandle
VolumeDevice getDeviceHandle() const
Get the volume device handle.
Definition: file.hxx:597
osl_Volume_Attribute_FloppyDisk
#define osl_Volume_Attribute_FloppyDisk
Definition: file.h:529
oslDirectory
void * oslDirectory
Definition: file.h:139
osl::Directory::remove
static RC remove(const ::rtl::OUString &ustrDirectoryURL)
Remove an empty directory.
Definition: file.hxx:1895
osl::FileStatus::getAccessTime
TimeValue getAccessTime() const
Get the file access time.
Definition: file.hxx:794
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::VolumeDevice::VolumeDevice
VolumeDevice()
Constructor.
Definition: file.hxx:331
osl_File_E_NOTDIR
Definition: file.h:105
osl::File::remove
static RC remove(const ::rtl::OUString &ustrFileURL)
Remove a regular file.
Definition: file.hxx:1363
OSL_PRECOND
#define OSL_PRECOND(c, m)
Check the precondition of functions.
Definition: diagnose.h:110
osl_replaceFile
SAL_DLLPUBLIC oslFileError osl_replaceFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Move a file to a new destination or rename it, taking old file's identity (if exists).
osl::DirectoryItem::getFileStatus
RC getFileStatus(FileStatus &rStatus)
Retrieve information about a single file or directory.
Definition: file.hxx:1566
osl_File_E_NOENT
Definition: file.h:88
osl::FileStatus::getFileSize
sal_uInt64 getFileSize() const
Get the size of the file.
Definition: file.hxx:823
osl::FileBase::E_PIPE
broken pipe; no process reading from other end of pipe
Definition: file.hxx:86
_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:380
rtl_uString_release
SAL_DLLPUBLIC void rtl_uString_release(rtl_uString *str) SAL_THROW_EXTERN_C() SAL_HOT
Decrement the reference count of a string.
osl::File::open
RC open(sal_uInt32 uFlags)
Open a regular file.
Definition: file.hxx:973
_oslFileStatus::uAttributes
sal_uInt64 uAttributes
File attributes.
Definition: file.h:386
osl::FileBase::E_NOMEM
no memory available
Definition: file.hxx:68
osl::FileBase::E_MFILE
process has too many distinct files open
Definition: file.hxx:79
osl_File_E_AGAIN
Definition: file.h:97
osl::Directory::close
RC close()
Close a directory.
Definition: file.hxx:1726
osl_File_E_NOSYS
Definition: file.h:122
osl::FileStatus::isRegular
bool isRegular() const
Is it a regular file?
Definition: file.hxx:740
osl_File_E_INVAL
Definition: file.h:107
osl::Directory::reset
RC reset()
Resets the directory item enumeration to the beginning.
Definition: file.hxx:1756
osl::VolumeInfo::getFreeSpace
sal_uInt64 getFreeSpace() const
Determine the free space of a volume device.
Definition: file.hxx:536
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:389
osl::VolumeInfo::getFileSystemName
::rtl::OUString getFileSystemName() const
Determine the name of the volume device's File System.
Definition: file.hxx:584
osl_Volume_Attribute_FixedDisk
#define osl_Volume_Attribute_FixedDisk
Definition: file.h:527
osl_File_E_2BIG
Definition: file.h:93
diagnose.h
Provides simple diagnostic support.
osl::FileStatus::Fifo
Definition: file.hxx:657
time.h
osl::DirectoryCreationObserver
Base class for observers of directory creation notifications.
Definition: file.hxx:1605
osl::VolumeInfo::getMaxPathLength
sal_uInt32 getMaxPathLength() const
Determine the maximal length of a path name.
Definition: file.hxx:572
osl_File_E_None
Definition: file.h:86
osl::File::getPos
RC getPos(sal_uInt64 &uPos)
Retrieve the current position of the internal pointer of an open file.
Definition: file.hxx:1040
osl_isEndOfFile
SAL_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.