LibreOffice: osl/file.hxx Source File

LibreOffice LibreOffice 6.2 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 <cstddef>
28
29 #include "sal/log.hxx"
30 #include "osl/time.h"
31 #include "rtl/ustring.hxx"
32
33 #include "osl/file.h"
34 #include "osl/diagnose.h"
35
36 namespace rtl { class ByteSequence; }
37
38 namespace osl
39 {
40
41
49 class FileBase
50 {
51 public:
52
53 enum RC {
54 E_None = osl_File_E_None,
55 E_PERM = osl_File_E_PERM,
56 E_NOENT = osl_File_E_NOENT,
57 E_SRCH = osl_File_E_SRCH,
58 E_INTR = osl_File_E_INTR,
59 E_IO = osl_File_E_IO,
60 E_NXIO = osl_File_E_NXIO,
61 E_2BIG = osl_File_E_2BIG,
62 E_NOEXEC = osl_File_E_NOEXEC,
63 E_BADF = osl_File_E_BADF,
64 E_CHILD = osl_File_E_CHILD,
65 E_AGAIN = osl_File_E_AGAIN,
66 E_NOMEM = osl_File_E_NOMEM,
67 E_ACCES = osl_File_E_ACCES,
68 E_FAULT = osl_File_E_FAULT,
69 E_BUSY = osl_File_E_BUSY,
70 E_EXIST = osl_File_E_EXIST,
71 E_XDEV = osl_File_E_XDEV,
72 E_NODEV = osl_File_E_NODEV,
73 E_NOTDIR = osl_File_E_NOTDIR,
74 E_ISDIR = osl_File_E_ISDIR,
75 E_INVAL = osl_File_E_INVAL,
76 E_NFILE = osl_File_E_NFILE,
77 E_MFILE = osl_File_E_MFILE,
78 E_NOTTY = osl_File_E_NOTTY,
79 E_FBIG = osl_File_E_FBIG,
80 E_NOSPC = osl_File_E_NOSPC,
81 E_SPIPE = osl_File_E_SPIPE,
82 E_ROFS = osl_File_E_ROFS,
83 E_MLINK = osl_File_E_MLINK,
84 E_PIPE = osl_File_E_PIPE,
85 E_DOM = osl_File_E_DOM,
86 E_RANGE = osl_File_E_RANGE,
87 E_DEADLK = osl_File_E_DEADLK,
88 E_NAMETOOLONG = osl_File_E_NAMETOOLONG,
89 E_NOLCK = osl_File_E_NOLCK,
90 E_NOSYS = osl_File_E_NOSYS,
91 E_NOTEMPTY = osl_File_E_NOTEMPTY,
92 E_LOOP = osl_File_E_LOOP,
93 E_ILSEQ = osl_File_E_ILSEQ,
94 E_NOLINK = osl_File_E_NOLINK,
95 E_MULTIHOP = osl_File_E_MULTIHOP,
96 E_USERS = osl_File_E_USERS,
97 E_OVERFLOW = osl_File_E_OVERFLOW,
98 E_NOTREADY = osl_File_E_NOTREADY,
99 E_invalidError = osl_File_E_invalidError,
100 E_TIMEDOUT = osl_File_E_TIMEDOUT,
101 E_NETWORK = osl_File_E_NETWORK
102 };
103
104
105 public:
106
127 static RC getCanonicalName( const ::rtl::OUString& ustrRequestedURL, ::rtl::OUString& ustrValidURL )
128 {
129 return static_cast< RC >( osl_getCanonicalName( ustrRequestedURL.pData, &ustrValidURL.pData ) );
130 }
131
166 static RC getAbsoluteFileURL( const ::rtl::OUString& ustrBaseDirectoryURL, const ::rtl::OUString& ustrRelativeFileURL, ::rtl::OUString& ustrAbsoluteFileURL )
167 {
168 return static_cast< RC >( osl_getAbsoluteFileURL( ustrBaseDirectoryURL.pData, ustrRelativeFileURL.pData, &ustrAbsoluteFileURL.pData ) );
169 }
170
185 static RC getSystemPathFromFileURL( const ::rtl::OUString& ustrFileURL, ::rtl::OUString& ustrSystemPath )
186 {
187 return static_cast< RC >( osl_getSystemPathFromFileURL( ustrFileURL.pData, &ustrSystemPath.pData ) );
188 }
189
204 static RC getFileURLFromSystemPath( const ::rtl::OUString& ustrSystemPath, ::rtl::OUString& ustrFileURL )
205 {
206 return static_cast< RC >( osl_getFileURLFromSystemPath( ustrSystemPath.pData, &ustrFileURL.pData ) );
207 }
208
236 static RC searchFileURL( const ::rtl::OUString& ustrFileName, const ::rtl::OUString& ustrSearchPath, ::rtl::OUString& ustrFileURL )
237 {
238 return static_cast< RC >( osl_searchFileURL( ustrFileName.pData, ustrSearchPath.pData, &ustrFileURL.pData ) );
239 }
240
250 static RC getTempDirURL( ::rtl::OUString& ustrTempDirURL )
251 {
252 return static_cast< RC >( osl_getTempDirURL( &ustrTempDirURL.pData ) );
253 }
254
302 static RC createTempFile(
303 ::rtl::OUString* pustrDirectoryURL,
304 oslFileHandle* pHandle,
305 ::rtl::OUString* pustrTempFileURL)
306 {
307 rtl_uString* pustr_dir_url = pustrDirectoryURL ? pustrDirectoryURL->pData : NULL;
308 rtl_uString** ppustr_tmp_file_url = pustrTempFileURL ? &pustrTempFileURL->pData : NULL;
309
310 return static_cast< RC >( osl_createTempFile(pustr_dir_url, pHandle, ppustr_tmp_file_url) );
311 }
312 };
313
314
320 class VolumeDevice : public FileBase
321 {
322 oslVolumeDeviceHandle _aHandle;
323
324 public:
325
329 VolumeDevice() : _aHandle( NULL )
330 {
331 }
332
339 VolumeDevice( const VolumeDevice & rDevice )
340 {
341 _aHandle = rDevice._aHandle;
342 if ( _aHandle )
343 osl_acquireVolumeDeviceHandle( _aHandle );
344 }
345
349 ~VolumeDevice()
350 {
351 if ( _aHandle )
352 osl_releaseVolumeDeviceHandle( _aHandle );
353 }
354
361 VolumeDevice & operator =( const VolumeDevice & rDevice )
362 {
363 oslVolumeDeviceHandle newHandle = rDevice._aHandle;
364
365 if ( newHandle )
366 osl_acquireVolumeDeviceHandle( newHandle );
367
368 if ( _aHandle )
369 osl_releaseVolumeDeviceHandle( _aHandle );
370
371 _aHandle = newHandle;
372
373 return *this;
374 }
375
381 rtl::OUString getMountPath()
382 {
383 rtl::OUString aPath;
384 osl_getVolumeDeviceMountPath( _aHandle, &aPath.pData );
385 return aPath;
386 }
387
388 friend class VolumeInfo;
389 };
390
391
392 class Directory;
393
402 class VolumeInfo
403 {
404 oslVolumeInfo _aInfo;
405 sal_uInt32 _nMask;
406 VolumeDevice _aDevice;
407
411 VolumeInfo( VolumeInfo& ) SAL_DELETED_FUNCTION;
412
416 VolumeInfo& operator = ( VolumeInfo& ) SAL_DELETED_FUNCTION;
417
418 public:
419
425 VolumeInfo( sal_uInt32 nMask )
426 : _nMask( nMask )
427 {
428 memset( &_aInfo, 0, sizeof( oslVolumeInfo ));
429 _aInfo.uStructSize = sizeof( oslVolumeInfo );
430 _aInfo.pDeviceHandle = &_aDevice._aHandle;
431 }
432
433 ~VolumeInfo()
434 {
435 if( _aInfo.ustrFileSystemName )
436 rtl_uString_release( _aInfo.ustrFileSystemName );
437 }
438
446 bool isValid( sal_uInt32 nMask ) const
447 {
448 return ( nMask & _aInfo.uValidFields ) == nMask;
449 }
450
456 bool getRemoteFlag() const
457 {
458 return (_aInfo.uAttributes & osl_Volume_Attribute_Remote) != 0;
459 }
460
466 bool getRemoveableFlag() const
467 {
468 return (_aInfo.uAttributes & osl_Volume_Attribute_Removeable) != 0;
469 }
470
477 bool getCompactDiscFlag() const
478 {
479 return (_aInfo.uAttributes & osl_Volume_Attribute_CompactDisc) != 0;
480 }
481
488 bool getFloppyDiskFlag() const
489 {
490 return (_aInfo.uAttributes & osl_Volume_Attribute_FloppyDisk) != 0;
491 }
492
499 bool getFixedDiskFlag() const
500 {
501 return (_aInfo.uAttributes & osl_Volume_Attribute_FixedDisk) != 0;
502 }
503
510 bool getRAMDiskFlag() const
511 {
512 return (_aInfo.uAttributes & osl_Volume_Attribute_RAMDisk) != 0;
513 }
514
522 sal_uInt64 getTotalSpace() const
523 {
524 return _aInfo.uTotalSpace;
525 }
526
534 sal_uInt64 getFreeSpace() const
535 {
536 return _aInfo.uFreeSpace;
537 }
538
546 sal_uInt64 getUsedSpace() const
547 {
548 return _aInfo.uUsedSpace;
549 }
550
558 sal_uInt32 getMaxNameLength() const
559 {
560 return _aInfo.uMaxNameLength;
561 }
562
570 sal_uInt32 getMaxPathLength() const
571 {
572 return _aInfo.uMaxPathLength;
573 }
574
582 ::rtl::OUString getFileSystemName() const
583 {
584 return _aInfo.ustrFileSystemName ? ::rtl::OUString( _aInfo.ustrFileSystemName ) : ::rtl::OUString();
585 }
586
587
595 VolumeDevice getDeviceHandle() const
596 {
597 return _aDevice;
598 }
599
606 bool isCaseSensitiveFileSystem() const
607 {
608 return (_aInfo.uAttributes & osl_Volume_Attribute_Case_Sensitive) != 0;
609 }
610
618 bool isCasePreservingFileSystem() const
619 {
620 return (_aInfo.uAttributes & osl_Volume_Attribute_Case_Is_Preserved) != 0;
621 }
622
623 friend class Directory;
624 };
625
626
627 class DirectoryItem;
628
634 class FileStatus
635 {
636 oslFileStatus _aStatus;
637 sal_uInt32 _nMask;
638
642 FileStatus( FileStatus& ) SAL_DELETED_FUNCTION;
643
647 FileStatus& operator = ( FileStatus& ) SAL_DELETED_FUNCTION;
648
649 public:
650
651 enum Type {
652 Directory = osl_File_Type_Directory,
653 Volume = osl_File_Type_Volume,
654 Regular = osl_File_Type_Regular,
655 Fifo = osl_File_Type_Fifo,
656 Socket = osl_File_Type_Socket,
657 Link = osl_File_Type_Link,
658 Special = osl_File_Type_Special,
659 Unknown = osl_File_Type_Unknown
660 };
661
667 FileStatus(sal_uInt32 nMask)
668 : _nMask(nMask)
669 {
670 memset(&_aStatus, 0, sizeof(_aStatus));
671 _aStatus.uStructSize = sizeof(_aStatus);
672 }
673
676 ~FileStatus()
677 {
678 if ( _aStatus.ustrFileURL )
679 rtl_uString_release( _aStatus.ustrFileURL );
680 if ( _aStatus.ustrLinkTargetURL )
681 rtl_uString_release( _aStatus.ustrLinkTargetURL );
682 if ( _aStatus.ustrFileName )
683 rtl_uString_release( _aStatus.ustrFileName );
684 }
685
695 bool isValid( sal_uInt32 nMask ) const
696 {
697 return ( nMask & _aStatus.uValidFields ) == nMask;
698 }
699
705 Type getFileType() const
706 {
707 SAL_INFO_IF(
708 !isValid(osl_FileStatus_Mask_Type), "sal.osl",
709 "no FileStatus Type determined");
710 return isValid(osl_FileStatus_Mask_Type)
711 ? static_cast< Type >(_aStatus.eType) : Unknown;
712 }
713
723 bool isDirectory() const
724 {
725 return ( getFileType() == Directory || getFileType() == Volume );
726 }
727
738 bool isRegular() const
739 {
740 return ( getFileType() == Regular );
741 }
742
751 bool isLink() const
752 {
753 return ( getFileType() == Link );
754 }
755
762 sal_uInt64 getAttributes() const
763 {
764 SAL_INFO_IF(
765 !isValid(osl_FileStatus_Mask_Attributes), "sal.osl",
766 "no FileStatus Attributes determined");
767 return _aStatus.uAttributes;
768 }
769
777 TimeValue getCreationTime() const
778 {
779 SAL_INFO_IF(
780 !isValid(osl_FileStatus_Mask_CreationTime), "sal.osl",
781 "no FileStatus CreationTime determined");
782 return _aStatus.aCreationTime;
783 }
784
792 TimeValue getAccessTime() const
793 {
794 SAL_INFO_IF(
795 !isValid(osl_FileStatus_Mask_AccessTime), "sal.osl",
796 "no FileStatus AccessTime determined");
797 return _aStatus.aAccessTime;
798 }
799
807 TimeValue getModifyTime() const
808 {
809 SAL_INFO_IF(
810 !isValid(osl_FileStatus_Mask_ModifyTime), "sal.osl",
811 "no FileStatus ModifyTime determined");
812 return _aStatus.aModifyTime;
813 }
814
821 sal_uInt64 getFileSize() const
822 {
823 SAL_INFO_IF(
824 !isValid(osl_FileStatus_Mask_FileSize), "sal.osl",
825 "no FileStatus FileSize determined");
826 return _aStatus.uFileSize;
827 }
828
835 ::rtl::OUString getFileName() const
836 {
837 SAL_INFO_IF(
838 !isValid(osl_FileStatus_Mask_FileName), "sal.osl",
839 "no FileStatus FileName determined");
840 return isValid(osl_FileStatus_Mask_FileName)
841 ? rtl::OUString(_aStatus.ustrFileName) : rtl::OUString();
842 }
843
844
852 ::rtl::OUString getFileURL() const
853 {
854 SAL_INFO_IF(
855 !isValid(osl_FileStatus_Mask_FileURL), "sal.osl",
856 "no FileStatus FileURL determined");
857 return isValid(osl_FileStatus_Mask_FileURL)
858 ? rtl::OUString(_aStatus.ustrFileURL) : rtl::OUString();
859 }
860
868 ::rtl::OUString getLinkTargetURL() const
869 {
870 SAL_INFO_IF(
871 !isValid(osl_FileStatus_Mask_LinkTargetURL), "sal.osl",
872 "no FileStatus LinkTargetURL determined");
873 return isValid(osl_FileStatus_Mask_LinkTargetURL)
874 ? rtl::OUString(_aStatus.ustrLinkTargetURL) : rtl::OUString();
875 }
876
877 friend class DirectoryItem;
878 };
879
880
887 class File: public FileBase
888 {
889 oslFileHandle _pData;
890 ::rtl::OUString _aPath;
891
895 File( File& ) SAL_DELETED_FUNCTION;
896
900 File& operator = ( File& ) SAL_DELETED_FUNCTION;
901
902 public:
903
910 File( const ::rtl::OUString& ustrFileURL ): _pData( NULL ), _aPath( ustrFileURL ) {}
911
915 ~File()
916 {
917 close();
918 }
919
927 rtl::OUString getURL() const { return _aPath; }
928
971 RC open( sal_uInt32 uFlags )
972 {
973 return static_cast< RC >( osl_openFile( _aPath.pData, &_pData, uFlags ) );
974 }
975
989 RC close()
990 {
991 oslFileError Error = osl_File_E_BADF;
992
993 if( _pData )
994 {
995 Error=osl_closeFile( _pData );
996 _pData = NULL;
997 }
998
999 return static_cast< RC >( Error );
1000 }
1001
1018 SAL_WARN_UNUSED_RESULT RC setPos( sal_uInt32 uHow, sal_Int64 uPos )
1019 {
1020 return static_cast< RC >( osl_setFilePos( _pData, uHow, uPos ) );
1021 }
1022
1038 RC getPos( sal_uInt64& uPos )
1039 {
1040 return static_cast< RC >( osl_getFilePos( _pData, &uPos ) );
1041 }
1042
1064 RC isEndOfFile( sal_Bool *pIsEOF )
1065 {
1066 return static_cast< RC >( osl_isEndOfFile( _pData, pIsEOF ) );
1067 }
1068
1086 RC setSize( sal_uInt64 uSize )
1087 {
1088 return static_cast< RC >( osl_setFileSize( _pData, uSize ) );
1089 }
1090
1110 RC getSize( sal_uInt64 &rSize )
1111 {
1112 return static_cast< RC >( osl_getFileSize( _pData, &rSize ) );
1113 }
1114
1146 RC read( void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64& rBytesRead )
1147 {
1148 return static_cast< RC >( osl_readFile( _pData, pBuffer, uBytesRequested, &rBytesRead ) );
1149 }
1150
1184 RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64& rBytesWritten)
1185 {
1186 return static_cast< RC >( osl_writeFile( _pData, pBuffer, uBytesToWrite, &rBytesWritten ) );
1187 }
1188
1189
1213 RC readLine( ::rtl::ByteSequence& aSeq )
1214 {
1215 return static_cast< RC >( osl_readLine( _pData, reinterpret_cast<sal_Sequence**>(&aSeq) ) );
1216 }
1217
1237 RC sync() const
1238 {
1239 OSL_PRECOND(_pData, "File::sync(): File not open");
1240 return static_cast< RC >(osl_syncFile(_pData));
1241 }
1242
1268 static RC copy( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1269 {
1270 return static_cast< RC >( osl_copyFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1271 }
1272
1296 static RC move( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1297 {
1298 return static_cast< RC >( osl_moveFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1299 }
1300
1328 static RC replace(const ::rtl::OUString& ustrSourceFileURL,
1329 const ::rtl::OUString& ustrDestFileURL)
1330 {
1331 return static_cast<RC>(osl_replaceFile(ustrSourceFileURL.pData, ustrDestFileURL.pData));
1332 }
1333
1361 static RC remove( const ::rtl::OUString& ustrFileURL )
1362 {
1363 return static_cast< RC >( osl_removeFile( ustrFileURL.pData ) );
1364 }
1365
1381 static RC setAttributes( const ::rtl::OUString& ustrFileURL, sal_uInt64 uAttributes )
1382 {
1383 return static_cast< RC >( osl_setFileAttributes( ustrFileURL.pData, uAttributes ) );
1384 }
1385
1407 static RC setTime(
1408 const ::rtl::OUString& ustrFileURL,
1409 const TimeValue& rCreationTime,
1410 const TimeValue& rLastAccessTime,
1411 const TimeValue& rLastWriteTime )
1412 {
1413 return static_cast< RC >( osl_setFileTime(
1414 ustrFileURL.pData,
1415 &rCreationTime,
1416 &rLastAccessTime,
1417 &rLastWriteTime ) );
1418 }
1419
1420 friend class DirectoryItem;
1421 };
1422
1423
1429 class DirectoryItem: public FileBase
1430 {
1431 oslDirectoryItem _pData;
1432
1433 public:
1434
1438 DirectoryItem(): _pData( NULL )
1439 {
1440 }
1441
1445 DirectoryItem( const DirectoryItem& rItem ): _pData( rItem._pData)
1446 {
1447 if( _pData )
1448 osl_acquireDirectoryItem( _pData );
1449 }
1450
1454 ~DirectoryItem()
1455 {
1456 if( _pData )
1457 osl_releaseDirectoryItem( _pData );
1458 }
1459
1463 DirectoryItem& operator=(const DirectoryItem& rItem )
1464 {
1465 if (&rItem != this)
1466 {
1467 if( _pData )
1468 osl_releaseDirectoryItem( _pData );
1469
1470 _pData = rItem._pData;
1471
1472 if( _pData )
1473 osl_acquireDirectoryItem( _pData );
1474 }
1475 return *this;
1476 }
1477
1484 bool is()
1485 {
1486 return _pData != NULL;
1487 }
1488
1522 static RC get( const ::rtl::OUString& ustrFileURL, DirectoryItem& rItem )
1523 {
1524 if( rItem._pData)
1525 {
1526 osl_releaseDirectoryItem( rItem._pData );
1527 rItem._pData = NULL;
1528 }
1529
1530 return static_cast< RC >( osl_getDirectoryItem( ustrFileURL.pData, &rItem._pData ) );
1531 }
1532
1564 RC getFileStatus( FileStatus& rStatus )
1565 {
1566 return static_cast< RC >( osl_getFileStatus( _pData, &rStatus._aStatus, rStatus._nMask ) );
1567 }
1568
1584 bool isIdenticalTo( const DirectoryItem &pOther )
1585 {
1586 return osl_identicalDirectoryItem( _pData, pOther._pData );
1587 }
1588
1589 friend class Directory;
1590 };
1591
1592
1603 class DirectoryCreationObserver
1604 {
1605 public:
1606 virtual ~DirectoryCreationObserver() {}
1607
1617 virtual void DirectoryCreated(const rtl::OUString& aDirectoryUrl) = 0;
1618 };
1619
1620
1621 // This just an internal helper function for
1622 // private use.
1623 extern "C" inline void SAL_CALL onDirectoryCreated(void* pData, rtl_uString* aDirectoryUrl)
1624 {
1625 static_cast<DirectoryCreationObserver*>(pData)->DirectoryCreated(aDirectoryUrl);
1626 }
1627
1634 class Directory: public FileBase
1635 {
1636 oslDirectory _pData;
1637 ::rtl::OUString _aPath;
1638
1642 Directory( Directory& ) SAL_DELETED_FUNCTION;
1643
1647 Directory& operator = ( Directory& ) SAL_DELETED_FUNCTION;
1648
1649 public:
1650
1658 Directory( const ::rtl::OUString& strPath ): _pData( NULL ), _aPath( strPath )
1659 {
1660 }
1661
1665 ~Directory()
1666 {
1667 close();
1668 }
1669
1677 rtl::OUString getURL() const { return _aPath; }
1678
1696 RC open()
1697 {
1698 return static_cast< RC >( osl_openDirectory( _aPath.pData, &_pData ) );
1699 }
1700
1711 bool isOpen() { return _pData != NULL; }
1712
1724 RC close()
1725 {
1726 oslFileError Error = osl_File_E_BADF;
1727
1728 if( _pData )
1729 {
1730 Error=osl_closeDirectory( _pData );
1731 _pData = NULL;
1732 }
1733
1734 return static_cast< RC >( Error );
1735 }
1736
1737
1754 RC reset()
1755 {
1756 close();
1757 return open();
1758 }
1759
1782 RC getNextItem( DirectoryItem& rItem, sal_uInt32 nHint = 0 )
1783 {
1784 if( rItem._pData )
1785 {
1786 osl_releaseDirectoryItem( rItem._pData );
1787 rItem._pData = NULL;
1788 }
1789 return static_cast<RC>(osl_getNextDirectoryItem( _pData, &rItem._pData, nHint ));
1790 }
1791
1792
1823 static RC getVolumeInfo( const ::rtl::OUString& ustrDirectoryURL, VolumeInfo& rInfo )
1824 {
1825 return static_cast< RC >( osl_getVolumeInformation( ustrDirectoryURL.pData, &rInfo._aInfo, rInfo._nMask ) );
1826 }
1827
1858 static RC create(
1859 const ::rtl::OUString& ustrDirectoryURL,
1860 sal_uInt32 flags = osl_File_OpenFlag_Read | osl_File_OpenFlag_Write )
1861 {
1862 return static_cast< RC >(
1863 osl_createDirectoryWithFlags( ustrDirectoryURL.pData, flags ) );
1864 }
1865
1893 static RC remove( const ::rtl::OUString& ustrDirectoryURL )
1894 {
1895 return static_cast< RC >( osl_removeDirectory( ustrDirectoryURL.pData ) );
1896 }
1897
1934 static RC createPath(
1935 const ::rtl::OUString& aDirectoryUrl,
1936 DirectoryCreationObserver* aDirectoryCreationObserver = NULL)
1937 {
1938 return static_cast< RC >(osl_createDirectoryPath(
1939 aDirectoryUrl.pData,
1940 aDirectoryCreationObserver ? onDirectoryCreated : NULL,
1941 aDirectoryCreationObserver));
1942 }
1943 };
1944
1945 } /* namespace osl */
1946
1947 #endif // INCLUDED_OSL_FILE_HXX
1948
1949 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
osl::FileStatus::getFileName
::rtl::OUString getFileName() const
Get the file name.
Definition: file.hxx:835
osl::FileBase::RC
RC
Definition: file.hxx:53
osl_File_E_invalidError
Definition: file.h:131
osl_closeDirectory
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
osl::FileStatus::Unknown
Definition: file.hxx:659
osl::Directory::Directory
Directory(const ::rtl::OUString &strPath)
Constructor.
Definition: file.hxx:1658
osl::DirectoryItem::is
bool is()
Check for validity of this instance.
Definition: file.hxx:1484
osl::File::setPos
SAL_WARN_UNUSED_RESULT RC setPos(sal_uInt32 uHow, sal_Int64 uPos)
Set the internal position pointer of an open file.
Definition: file.hxx:1018
osl_acquireVolumeDeviceHandle
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Acquire a volume device handle.
osl_File_E_DOM
Definition: file.h:117
_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::FileBase::E_CHILD
there are no child processes
Definition: file.hxx:64
osl_File_E_ROFS
Definition: file.h:114
osl::File::readLine
RC readLine(::rtl::ByteSequence &aSeq)
Read a line from a file.
Definition: file.hxx:1213
osl::FileBase::E_ILSEQ
invalid or incomplete byte sequence of multibyte char found
Definition: file.hxx:93
osl_getSystemPathFromFileURL
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
osl::VolumeDevice
The VolumeDevice class.
Definition: file.hxx:320
osl::File::getPos
RC getPos(sal_uInt64 &uPos)
Retrieve the current position of the internal pointer of an open file.
Definition: file.hxx:1038
osl_File_E_NAMETOOLONG
Definition: file.h:120
osl::File::remove
static RC remove(const ::rtl::OUString &ustrFileURL)
Remove a regular file.
Definition: file.hxx:1361
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_PERM
operation not permitted
Definition: file.hxx:55
osl::FileBase::E_NOLINK
link has been severed
Definition: file.hxx:94
osl_File_E_ISDIR
Definition: file.h:106
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_isEndOfFile
SAL_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.
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::Regular
Definition: file.hxx:654
osl::File::open
RC open(sal_uInt32 uFlags)
Open a regular file.
Definition: file.hxx:971
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::FileStatus::~FileStatus
~FileStatus()
Destructor.
Definition: file.hxx:676
osl::FileStatus::Link
Definition: file.hxx:657
osl_File_E_RANGE
Definition: file.h:118
osl::FileBase::E_NAMETOOLONG
filename too long
Definition: file.hxx:88
osl_Volume_Attribute_FixedDisk
#define osl_Volume_Attribute_FixedDisk
Definition: file.h:527
osl::FileBase::E_NOTTY
inappropriate I/O control operation
Definition: file.hxx:78
_oslVolumeInfo::ustrFileSystemName
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:581
osl_File_E_PIPE
Definition: file.h:116
osl_File_E_NETWORK
Definition: file.h:133
osl::FileBase::E_ACCES
file permissions do not allow operation
Definition: file.hxx:67
osl_File_E_NOTTY
Definition: file.h:110
_oslVolumeInfo::pDeviceHandle
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:584
osl::VolumeInfo::getUsedSpace
sal_uInt64 getUsedSpace() const
Determine the used space of a volume device.
Definition: file.hxx:546
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:185
_oslVolumeInfo::uAttributes
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:567
osl_removeFile
SAL_DLLPUBLIC oslFileError osl_removeFile(rtl_uString *pustrFileURL)
Remove a regular file.
osl_File_E_MLINK
Definition: file.h:115
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:1858
osl_File_E_NOLINK
Definition: file.h:126
osl::FileBase::E_NOTDIR
file isn't a directory where one is needed
Definition: file.hxx:73
osl_File_E_MFILE
Definition: file.h:109
osl_getFileStatus
SAL_DLLPUBLIC oslFileError osl_getFileStatus(oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask)
Retrieve information about a single file or directory.
osl_Volume_Attribute_FloppyDisk
#define osl_Volume_Attribute_FloppyDisk
Definition: file.h:529
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::getURL
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:1677
osl_File_E_LOOP
Definition: file.h:124
osl::Directory::getNextItem
RC getNextItem(DirectoryItem &rItem, sal_uInt32 nHint=0)
Retrieve the next item of a previously opened directory.
Definition: file.hxx:1782
string.h
osl::FileBase::E_None
on success
Definition: file.hxx:54
osl::FileBase::E_NODEV
wrong device type specified
Definition: file.hxx:72
oslFileHandle
void * oslFileHandle
Definition: file.h:626
osl::FileBase::E_NOSYS
function not implemented
Definition: file.hxx:90
osl::VolumeInfo::getRemoteFlag
bool getRemoteFlag() const
Check the remote flag.
Definition: file.hxx:456
osl::FileStatus::getAccessTime
TimeValue getAccessTime() const
Get the file access time.
Definition: file.hxx:792
osl_getFileURLFromSystemPath
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath(rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
Convert a system dependent path into a file URL.
osl_File_E_CHILD
Definition: file.h:96
osl::FileBase::E_NOTEMPTY
directory not empty
Definition: file.hxx:91
osl_FileStatus_Mask_FileSize
#define osl_FileStatus_Mask_FileSize
Definition: file.h:365
osl_releaseDirectoryItem
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem(oslDirectoryItem Item)
Decrease the refcount of a directory item handle.
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:204
osl_openDirectory
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
osl::FileBase::E_NETWORK
Definition: file.hxx:101
osl_getFileSize
SAL_DLLPUBLIC oslFileError osl_getFileSize(oslFileHandle Handle, sal_uInt64 *pSize)
Get the file size of an open file.
osl_FileStatus_Mask_CreationTime
#define osl_FileStatus_Mask_CreationTime
Definition: file.h:362
osl_File_E_PERM
Definition: file.h:87
osl::FileStatus::Volume
Definition: file.hxx:653
osl_File_E_NOEXEC
Definition: file.h:94
osl_File_E_EXIST
Definition: file.h:102
osl_FileStatus_Mask_FileName
#define osl_FileStatus_Mask_FileName
Definition: file.h:366
osl::FileBase::E_BUSY
resource busy
Definition: file.hxx:69
log.hxx
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:1296
osl::DirectoryItem
The directory item class object provides access to file status information.
Definition: file.hxx:1429
rtl::ByteSequence
C++ class representing a SAL byte sequence.
Definition: byteseq.h:165
osl_File_E_FBIG
Definition: file.h:111
_oslVolumeInfo::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:565
osl::FileBase::E_TIMEDOUT
socket operation timed out
Definition: file.hxx:100
osl::FileStatus::isRegular
bool isRegular() const
Is it a regular file?
Definition: file.hxx:738
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_NODEV
Definition: file.h:104
_oslVolumeInfo::uUsedSpace
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:571
osl_File_E_DEADLK
Definition: file.h:119
_oslFileStatus::uFileSize
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:396
osl::FileBase::E_NOLCK
no locks available
Definition: file.hxx:89
osl::FileBase::E_NXIO
no such device or address
Definition: file.hxx:60
osl
Definition: condition.hxx:28
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:1328
osl::FileBase::E_BADF
bad file descriptor
Definition: file.hxx:63
osl::FileBase::E_AGAIN
resource temp unavailable, try again later
Definition: file.hxx:65
osl::FileBase::E_XDEV
improper link across file systems detected
Definition: file.hxx:71
osl_File_E_AGAIN
Definition: file.h:97
osl::FileBase::E_OVERFLOW
value too large for defined data type
Definition: file.hxx:97
osl_FileStatus_Mask_FileURL
#define osl_FileStatus_Mask_FileURL
Definition: file.h:367
osl_File_E_TIMEDOUT
Definition: file.h:132
osl_File_E_NOLCK
Definition: file.h:121
osl::FileBase::E_FBIG
file too large
Definition: file.hxx:79
osl::FileStatus
The FileStatus class.
Definition: file.hxx:634
osl::FileBase::E_DOM
domain error (mathematical error)
Definition: file.hxx:85
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:166
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::FileStatus::isLink
bool isLink() const
Is it a link?
Definition: file.hxx:751
osl::onDirectoryCreated
void onDirectoryCreated(void *pData, rtl_uString *aDirectoryUrl)
Definition: file.hxx:1623
TimeValue
Definition: time.h:66
osl::Directory::~Directory
~Directory()
Destructor.
Definition: file.hxx:1665
osl::File::copy
static RC copy(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Copy a file to a new destination.
Definition: file.hxx:1268
osl_copyFile
SAL_DLLPUBLIC oslFileError osl_copyFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Copy a file to a new destination.
osl_File_E_NOTDIR
Definition: file.h:105
osl::File::read
RC read(void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 &rBytesRead)
Read a number of bytes from a file.
Definition: file.hxx:1146
osl::FileBase::E_invalidError
unmapped error: always last entry in enum!
Definition: file.hxx:99
osl_File_E_SRCH
Definition: file.h:89
osl::DirectoryItem::get
static RC get(const ::rtl::OUString &ustrFileURL, DirectoryItem &rItem)
Retrieve a single directory item.
Definition: file.hxx:1522
osl::Directory
The directory class object provides a enumeration of DirectoryItems.
Definition: file.hxx:1634
osl_File_Type_Fifo
Definition: file.h:328
osl_createDirectoryPath
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath(rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
Create a directory path.
osl_setFileSize
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
osl::FileBase::E_PIPE
broken pipe; no process reading from other end of pipe
Definition: file.hxx:84
osl_releaseVolumeDeviceHandle
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
osl::File
The file class object provides access to file contents and attributes.
Definition: file.hxx:887
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:236
osl_File_Type_Special
Definition: file.h:331
sal_Bool
unsigned char sal_Bool
Definition: types.h:38
osl_getDirectoryItem
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem(rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
Retrieve a single directory item.
config.h
osl::VolumeInfo::~VolumeInfo
~VolumeInfo()
Definition: file.hxx:433
osl::FileBase::E_ISDIR
file is a directory, invalid operation
Definition: file.hxx:74
osl::File::close
RC close()
Close an open file.
Definition: file.hxx:989
osl::FileBase::E_NOMEM
no memory available
Definition: file.hxx:66
osl_File_E_ACCES
Definition: file.h:99
osl_File_E_INVAL
Definition: file.h:107
osl_File_E_INTR
Definition: file.h:90
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:1407
osl::FileBase::E_NOEXEC
invalid executable file format
Definition: file.hxx:62
osl::DirectoryItem::~DirectoryItem
~DirectoryItem()
Destructor.
Definition: file.hxx:1454
_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
osl_File_E_2BIG
Definition: file.h:93
osl::FileBase::E_ROFS
illegal modification to read-only filesystem
Definition: file.hxx:82
osl::File::File
File(const ::rtl::OUString &ustrFileURL)
Constructor.
Definition: file.hxx:910
oslFileError
oslFileError
Definition: file.h:85
osl::Socket
Definition: socket_decl.hxx:191
_oslVolumeInfo::uMaxPathLength
sal_uInt32 uMaxPathLength
Maximum length of a full qualified path in system notation.
Definition: file.h:577
osl::FileStatus::isValid
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:695
osl::VolumeInfo::getFreeSpace
sal_uInt64 getFreeSpace() const
Determine the free space of a volume device.
Definition: file.hxx:534
osl::VolumeInfo
The VolumeInfo class.
Definition: file.hxx:402
osl::VolumeInfo::getFileSystemName
::rtl::OUString getFileSystemName() const
Determine the name of the volume device's File System.
Definition: file.hxx:582
OSL_PRECOND
#define OSL_PRECOND(c, m)
Check the precondition of functions.
Definition: diagnose.h:109
_oslVolumeInfo::uTotalSpace
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:569
osl::VolumeInfo::getFloppyDiskFlag
bool getFloppyDiskFlag() const
Check the floppy disc flag.
Definition: file.hxx:488
osl::DirectoryItem::DirectoryItem
DirectoryItem()
Constructor.
Definition: file.hxx:1438
osl_File_E_IO
Definition: file.h:91
osl_File_OpenFlag_Read
#define osl_File_OpenFlag_Read
Definition: file.h:630
osl::FileBase::E_MFILE
process has too many distinct files open
Definition: file.hxx:77
osl_openFile
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
osl_File_E_NOSYS
Definition: file.h:122
_oslFileStatus::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:382
osl::FileBase::E_NFILE
too many distinct file openings
Definition: file.hxx:76
osl_File_E_BADF
Definition: file.h:95
osl::VolumeInfo::getRAMDiskFlag
bool getRAMDiskFlag() const
Check the RAM disk flag.
Definition: file.hxx:510
_oslFileStatus::aModifyTime
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:394
osl_File_Type_Directory
Definition: file.h:325
osl::FileBase::E_MULTIHOP
remote resource is not directly available
Definition: file.hxx:95
osl::VolumeInfo::getTotalSpace
sal_uInt64 getTotalSpace() const
Determine the total space of a volume device.
Definition: file.hxx:522
_oslFileStatus::ustrFileName
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:399
osl::File::getSize
RC getSize(sal_uInt64 &rSize)
Get the file size of an open file.
Definition: file.hxx:1110
osl::FileStatus::Type
Type
Definition: file.hxx:651
ustring.hxx
osl_Volume_Attribute_Case_Is_Preserved
#define osl_Volume_Attribute_Case_Is_Preserved
Definition: file.h:531
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_getVolumeDeviceMountPath
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath(oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
Get the full qualified URL where a device is mounted to.
osl::FileStatus::Fifo
Definition: file.hxx:655
osl::File::sync
RC sync() const
Synchronize the memory representation of a file with that on the physical medium.
Definition: file.hxx:1237
osl::FileStatus::FileStatus
FileStatus(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:667
_oslVolumeInfo::uFreeSpace
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:573
_oslFileStatus::ustrLinkTargetURL
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:406
_oslVolumeInfo::uMaxNameLength
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:575
osl_setFileTime
SAL_DLLPUBLIC oslFileError osl_setFileTime(rtl_uString *pustrFileURL, const TimeValue *aCreationTime, const TimeValue *aLastAccessTime, const TimeValue *aLastWriteTime)
Set the file time.
osl_createDirectoryWithFlags
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
osl::FileStatus::Special
Definition: file.hxx:658
oslVolumeDeviceHandle
void * oslVolumeDeviceHandle
Definition: file.h:450
osl_File_Type_Link
Definition: file.h:330
osl_File_E_NOENT
Definition: file.h:88
osl::VolumeInfo::getDeviceHandle
VolumeDevice getDeviceHandle() const
Get the volume device handle.
Definition: file.hxx:595
osl_File_OpenFlag_Write
#define osl_File_OpenFlag_Write
Definition: file.h:631
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::FileBase::E_2BIG
argument list too long
Definition: file.hxx:61
osl_FileStatus_Mask_LinkTargetURL
#define osl_FileStatus_Mask_LinkTargetURL
Definition: file.h:368
osl_setFileAttributes
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
osl_FileStatus_Mask_AccessTime
#define osl_FileStatus_Mask_AccessTime
Definition: file.h:363
osl::DirectoryItem::getFileStatus
RC getFileStatus(FileStatus &rStatus)
Retrieve information about a single file or directory.
Definition: file.hxx:1564
osl::FileStatus::getFileSize
sal_uInt64 getFileSize() const
Get the size of the file.
Definition: file.hxx:821
osl::FileStatus::getFileURL
::rtl::OUString getFileURL() const
Get the URL of the file.
Definition: file.hxx:852
osl::FileStatus::getAttributes
sal_uInt64 getAttributes() const
Get the file attributes.
Definition: file.hxx:762
osl_readLine
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
osl::VolumeDevice::getMountPath
rtl::OUString getMountPath()
Get the full qualified URL where a device is mounted to.
Definition: file.hxx:381
osl_Volume_Attribute_CompactDisc
#define osl_Volume_Attribute_CompactDisc
Definition: file.h:526
osl_File_E_SPIPE
Definition: file.h:113
osl::FileBase
Base class for all File System specific objects.
Definition: file.hxx:49
osl_getVolumeInformation
SAL_DLLPUBLIC oslFileError osl_getVolumeInformation(rtl_uString *pustrDirectoryURL, oslVolumeInfo *pInfo, sal_uInt32 uFieldMask)
Retrieve information about a volume.
osl_FileStatus_Mask_ModifyTime
#define osl_FileStatus_Mask_ModifyTime
Definition: file.h:364
osl_File_E_None
Definition: file.h:86
_oslFileStatus::uAttributes
sal_uInt64 uAttributes
File attributes.
Definition: file.h:386
osl::Directory::isOpen
bool isOpen()
Query if directory is open.
Definition: file.hxx:1711
osl::FileBase::E_INTR
function call was interrupted
Definition: file.hxx:58
osl_File_E_NOMEM
Definition: file.h:98
_oslFileStatus::eType
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:384
file.h
osl_File_Type_Volume
Definition: file.h:326
osl::File::setSize
RC setSize(sal_uInt64 uSize)
Set the file size of an open file.
Definition: file.hxx:1086
osl_FileStatus_Mask_Type
#define osl_FileStatus_Mask_Type
Definition: file.h:360
osl::FileBase::E_EXIST
file exists where should only be created
Definition: file.hxx:70
osl::Directory::reset
RC reset()
Resets the directory item enumeration to the beginning.
Definition: file.hxx:1754
osl_File_E_NOSPC
Definition: file.h:112
osl_File_E_ILSEQ
Definition: file.h:125
osl::Directory::close
RC close()
Close a directory.
Definition: file.hxx:1724
osl_getTempDirURL
SAL_DLLPUBLIC oslFileError osl_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
osl_Volume_Attribute_RAMDisk
#define osl_Volume_Attribute_RAMDisk
Definition: file.h:528
osl_File_Type_Socket
Definition: file.h:329
osl::VolumeInfo::VolumeInfo
VolumeInfo(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:425
osl::DirectoryItem::DirectoryItem
DirectoryItem(const DirectoryItem &rItem)
Copy constructor.
Definition: file.hxx:1445
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:302
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::FileBase::E_MLINK
too many links to file
Definition: file.hxx:83
osl::FileBase::E_NOENT
no such file or directory
Definition: file.hxx:56
osl::File::isEndOfFile
RC isEndOfFile(sal_Bool *pIsEOF)
Test if the end of a file is reached.
Definition: file.hxx:1064
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:302
osl::Directory::createPath
static RC createPath(const ::rtl::OUString &aDirectoryUrl, DirectoryCreationObserver *aDirectoryCreationObserver=NULL)
Create a directory path.
Definition: file.hxx:1934
osl_removeDirectory
SAL_DLLPUBLIC oslFileError osl_removeDirectory(rtl_uString *pustrDirectoryURL)
Remove an empty directory.
osl_setFilePos
SAL_WARN_UNUSED_RESULT SAL_DLLPUBLIC oslFileError osl_setFilePos(oslFileHandle Handle, sal_uInt32 uHow, sal_Int64 uPos)
Set the internal position pointer of an open file.
_oslFileStatus
Structure containing information about files and directories.
Definition: file.h:378
osl::FileBase::E_FAULT
bad address; an invalid pointer detected
Definition: file.hxx:68
osl::FileStatus::getLinkTargetURL
::rtl::OUString getLinkTargetURL() const
Get the link target URL.
Definition: file.hxx:868
osl::VolumeInfo::getMaxNameLength
sal_uInt32 getMaxNameLength() const
Determine the maximal length of a file name.
Definition: file.hxx:558
osl_FileStatus_Mask_Attributes
#define osl_FileStatus_Mask_Attributes
Definition: file.h:361
rtl
Definition: bootstrap.hxx:29
osl_File_E_BUSY
Definition: file.h:101
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:123
osl::FileStatus::isDirectory
bool isDirectory() const
Is it a directory? This method returns True for both directories, and volumes.
Definition: file.hxx:723
osl_File_E_FAULT
Definition: file.h:100
osl::File::~File
~File()
Destructor.
Definition: file.hxx:915
osl::FileBase::E_DEADLK
deadlock avoided
Definition: file.hxx:87
osl_File_Type_Unknown
Definition: file.h:332
osl::VolumeInfo::isValid
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:446
osl_Volume_Attribute_Removeable
#define osl_Volume_Attribute_Removeable
Definition: file.h:524
osl::VolumeInfo::isCasePreservingFileSystem
bool isCasePreservingFileSystem() const
Return whether the file system preserves the case of file and directory names or not.
Definition: file.hxx:618
osl::Directory::open
RC open()
Open a directory for enumerating its contents.
Definition: file.hxx:1696
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::VolumeDevice::VolumeDevice
VolumeDevice(const VolumeDevice &rDevice)
Copy constructor.
Definition: file.hxx:339
oslDirectory
void * oslDirectory
Definition: file.h:139
_oslVolumeInfo
Structure containing information about volumes.
Definition: file.h:560
osl::VolumeDevice::operator=
VolumeDevice & operator=(const VolumeDevice &rDevice)
Assignment operator.
Definition: file.hxx:361
osl::FileBase::E_SPIPE
invalid seek operation (such as on pipe)
Definition: file.hxx:81
osl::Directory::remove
static RC remove(const ::rtl::OUString &ustrDirectoryURL)
Remove an empty directory.
Definition: file.hxx:1893
osl::FileBase::E_INVAL
invalid argument to library function
Definition: file.hxx:75
osl::File::setAttributes
static RC setAttributes(const ::rtl::OUString &ustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
Definition: file.hxx:1381
osl::VolumeDevice::~VolumeDevice
~VolumeDevice()
Destructor.
Definition: file.hxx:349
osl_File_E_NFILE
Definition: file.h:108
osl::VolumeInfo::isCaseSensitiveFileSystem
bool isCaseSensitiveFileSystem() const
Return whether the file system is case sensitive or case insensitive.
Definition: file.hxx:606
osl::VolumeDevice::VolumeDevice
VolumeDevice()
Constructor.
Definition: file.hxx:329
osl::FileBase::E_USERS
file quote system is confused as there are too many users
Definition: file.hxx:96
SAL_DELETED_FUNCTION
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:396
osl_File_Type_Regular
Definition: file.h:327
osl::VolumeInfo::getCompactDiscFlag
bool getCompactDiscFlag() const
Check the compact disc flag.
Definition: file.hxx:477
osl::File::getURL
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:927
osl::VolumeInfo::getRemoveableFlag
bool getRemoveableFlag() const
Check the removable flag.
Definition: file.hxx:466
oslDirectoryItem
void * oslDirectoryItem
Definition: file.h:140
osl_Volume_Attribute_Case_Sensitive
#define osl_Volume_Attribute_Case_Sensitive
Definition: file.h:532
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::VolumeInfo::getFixedDiskFlag
bool getFixedDiskFlag() const
Check the fixed disk flag.
Definition: file.hxx:499
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:92
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:1184
osl_File_E_NOTEMPTY
Definition: file.h:123
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...
osl_File_E_MULTIHOP
Definition: file.h:127
_oslFileStatus::aCreationTime
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:389
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:392
osl_getCanonicalName
SAL_DLLPUBLIC oslFileError osl_getCanonicalName(rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
Determine a valid unused canonical name for a requested name.
diagnose.h
osl::Directory::getVolumeInfo
static RC getVolumeInfo(const ::rtl::OUString &ustrDirectoryURL, VolumeInfo &rInfo)
Retrieve information about a volume.
Definition: file.hxx:1823
osl::DirectoryCreationObserver::~DirectoryCreationObserver
virtual ~DirectoryCreationObserver()
Definition: file.hxx:1606
osl_identicalDirectoryItem
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem(oslDirectoryItem pItemA, oslDirectoryItem pItemB)
Determine if two directory items point the same underlying file.
osl::FileStatus::getCreationTime
TimeValue getCreationTime() const
Get the creation time of this file.
Definition: file.hxx:777
osl::VolumeInfo::getMaxPathLength
sal_uInt32 getMaxPathLength() const
Determine the maximal length of a path name.
Definition: file.hxx:570
osl::FileBase::E_NOTREADY
device not ready
Definition: file.hxx:98
time.h
osl::FileBase::E_NOSPC
no space left on device, write failed
Definition: file.hxx:80
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:127
osl::FileStatus::getFileType
Type getFileType() const
Get the file type.
Definition: file.hxx:705
oslVolumeInfo
struct _oslVolumeInfo oslVolumeInfo
Structure containing information about volumes.
osl::DirectoryItem::operator=
DirectoryItem & operator=(const DirectoryItem &rItem)
Assignment operator.
Definition: file.hxx:1463
osl_File_E_USERS
Definition: file.h:128
osl_File_E_OVERFLOW
Definition: file.h:129
osl::DirectoryCreationObserver
Base class for observers of directory creation notifications.
Definition: file.hxx:1603
osl::DirectoryItem::isIdenticalTo
bool isIdenticalTo(const DirectoryItem &pOther)
Determine if a directory item point the same underlying file.
Definition: file.hxx:1584
osl::FileBase::E_RANGE
range error (mathematical error)
Definition: file.hxx:86
osl::FileBase::E_SRCH
no process matches the PID
Definition: file.hxx:57
osl::FileBase::getTempDirURL
static RC getTempDirURL(::rtl::OUString &ustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
Definition: file.hxx:250
osl_closeFile
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
osl::FileStatus::getModifyTime
TimeValue getModifyTime() const
Get the file modification time.
Definition: file.hxx:807
osl_File_E_NXIO
Definition: file.h:92
osl_File_E_XDEV
Definition: file.h:103
osl_Volume_Attribute_Remote
#define osl_Volume_Attribute_Remote
Definition: file.h:525
osl::FileBase::E_IO
I/O error occurred.
Definition: file.hxx:59
_oslFileStatus::ustrFileURL
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:402