LibreOffice LibreOffice 4.4 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

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
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 #include <rtl/byteseq.hxx>
36
37 #include <stdio.h>
38
39 namespace osl
40 {
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, /* unmapped error: always last entry in enum! */
102 E_TIMEDOUT = osl_File_E_TIMEDOUT,
103 E_NETWORK = osl_File_E_NETWORK
104 };
105
106
107 public:
108
130 static inline RC getCanonicalName( const ::rtl::OUString& ustrRequestedURL, ::rtl::OUString& ustrValidURL )
131 {
132 return static_cast< RC >( osl_getCanonicalName( ustrRequestedURL.pData, &ustrValidURL.pData ) );
133 }
134
170 static inline RC getAbsoluteFileURL( const ::rtl::OUString& ustrBaseDirectoryURL, const ::rtl::OUString& ustrRelativeFileURL, ::rtl::OUString& ustrAbsoluteFileURL )
171 {
172 return static_cast< RC >( osl_getAbsoluteFileURL( ustrBaseDirectoryURL.pData, ustrRelativeFileURL.pData, &ustrAbsoluteFileURL.pData ) );
173 }
174
190 static inline RC getSystemPathFromFileURL( const ::rtl::OUString& ustrFileURL, ::rtl::OUString& ustrSystemPath )
191 {
192 return static_cast< RC >( osl_getSystemPathFromFileURL( ustrFileURL.pData, &ustrSystemPath.pData ) );
193 }
194
210 static inline RC getFileURLFromSystemPath( const ::rtl::OUString& ustrSystemPath, ::rtl::OUString& ustrFileURL )
211 {
212 return static_cast< RC >( osl_getFileURLFromSystemPath( ustrSystemPath.pData, &ustrFileURL.pData ) );
213 }
214
243 static inline RC searchFileURL( const ::rtl::OUString& ustrFileName, const ::rtl::OUString& ustrSearchPath, ::rtl::OUString& ustrFileURL )
244 {
245 return static_cast< RC >( osl_searchFileURL( ustrFileName.pData, ustrSearchPath.pData, &ustrFileURL.pData ) );
246 }
247
258 static inline RC getTempDirURL( ::rtl::OUString& ustrTempDirURL )
259 {
260 return static_cast< RC >( osl_getTempDirURL( &ustrTempDirURL.pData ) );
261 }
262
311 static inline RC createTempFile(
312 ::rtl::OUString* pustrDirectoryURL,
313 oslFileHandle* pHandle,
314 ::rtl::OUString* pustrTempFileURL)
315 {
316 rtl_uString* pustr_dir_url = pustrDirectoryURL ? pustrDirectoryURL->pData : 0;
317 rtl_uString** ppustr_tmp_file_url = pustrTempFileURL ? &pustrTempFileURL->pData : 0;
318
319 return static_cast< RC >( osl_createTempFile(pustr_dir_url, pHandle, ppustr_tmp_file_url) );
320 }
321 };
322
323
324
330 class VolumeDevice : public FileBase
331 {
332 oslVolumeDeviceHandle _aHandle;
333
334 public:
335
339 VolumeDevice() : _aHandle( NULL )
340 {
341 }
342
349 VolumeDevice( const VolumeDevice & rDevice )
350 {
351 _aHandle = rDevice._aHandle;
352 if ( _aHandle )
353 osl_acquireVolumeDeviceHandle( _aHandle );
354 }
355
359 ~VolumeDevice()
360 {
361 if ( _aHandle )
362 osl_releaseVolumeDeviceHandle( _aHandle );
363 }
364
371 inline VolumeDevice & operator =( const VolumeDevice & rDevice )
372 {
373 oslVolumeDeviceHandle newHandle = rDevice._aHandle;
374
375 if ( newHandle )
376 osl_acquireVolumeDeviceHandle( newHandle );
377
378 if ( _aHandle )
379 osl_releaseVolumeDeviceHandle( _aHandle );
380
381 _aHandle = newHandle;
382
383 return *this;
384 }
385
391 inline rtl::OUString getMountPath()
392 {
393 rtl::OUString aPath;
394 osl_getVolumeDeviceMountPath( _aHandle, &aPath.pData );
395 return aPath;
396 }
397
398 friend class VolumeInfo;
399 };
400
401
402
403 class Directory;
404
413 class VolumeInfo
414 {
415 oslVolumeInfo _aInfo;
416 sal_uInt32 _nMask;
417 VolumeDevice _aDevice;
418
422 VolumeInfo( VolumeInfo& );
423
427 VolumeInfo& operator = ( VolumeInfo& );
428
429 public:
430
437 VolumeInfo( sal_uInt32 nMask )
438 : _nMask( nMask )
439 {
440 memset( &_aInfo, 0, sizeof( oslVolumeInfo ));
441 _aInfo.uStructSize = sizeof( oslVolumeInfo );
442 _aInfo.pDeviceHandle = &_aDevice._aHandle;
443 }
444
448 ~VolumeInfo()
449 {
450 if( _aInfo.ustrFileSystemName )
451 rtl_uString_release( _aInfo.ustrFileSystemName );
452 }
453
462 inline bool isValid( sal_uInt32 nMask ) const
463 {
464 return ( nMask & _aInfo.uValidFields ) == nMask;
465 }
466
473 inline bool getRemoteFlag() const
474 {
475 return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_Remote);
476 }
477
484 inline bool getRemoveableFlag() const
485 {
486 return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_Removeable);
487 }
488
495 inline bool getCompactDiscFlag() const
496 {
497 return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_CompactDisc);
498 }
499
506 inline bool getFloppyDiskFlag() const
507 {
508 return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_FloppyDisk);
509 }
510
517 inline bool getFixedDiskFlag() const
518 {
519 return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_FixedDisk);
520 }
521
528 inline bool getRAMDiskFlag() const
529 {
530 return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_RAMDisk);
531 }
532
540 inline sal_uInt64 getTotalSpace() const
541 {
542 return _aInfo.uTotalSpace;
543 }
544
552 inline sal_uInt64 getFreeSpace() const
553 {
554 return _aInfo.uFreeSpace;
555 }
556
564 inline sal_uInt64 getUsedSpace() const
565 {
566 return _aInfo.uUsedSpace;
567 }
568
576 inline sal_uInt32 getMaxNameLength() const
577 {
578 return _aInfo.uMaxNameLength;
579 }
580
588 inline sal_uInt32 getMaxPathLength() const
589 {
590 return _aInfo.uMaxPathLength;
591 }
592
600 inline ::rtl::OUString getFileSystemName() const
601 {
602 return _aInfo.ustrFileSystemName ? ::rtl::OUString( _aInfo.ustrFileSystemName ) : ::rtl::OUString();
603 }
604
605
613 inline VolumeDevice getDeviceHandle() const
614 {
615 return _aDevice;
616 }
617
624 bool isCaseSensitiveFileSystem() const
625 {
626 return (_aInfo.uAttributes & osl_Volume_Attribute_Case_Sensitive) != 0;
627 }
628
636 bool isCasePreservingFileSystem() const
637 {
638 return (_aInfo.uAttributes & osl_Volume_Attribute_Case_Is_Preserved) != 0;
639 }
640
641 friend class Directory;
642 };
643
644
645 class DirectoryItem;
646
652 class FileStatus
653 {
654 oslFileStatus _aStatus;
655 sal_uInt32 _nMask;
656
660 FileStatus( FileStatus& );
661
665 FileStatus& operator = ( FileStatus& );
666
667 public:
668
669 enum Type {
670 Directory = osl_File_Type_Directory,
671 Volume = osl_File_Type_Volume,
672 Regular = osl_File_Type_Regular,
673 Fifo = osl_File_Type_Fifo,
674 Socket = osl_File_Type_Socket,
675 Link = osl_File_Type_Link,
676 Special = osl_File_Type_Special,
677 Unknown = osl_File_Type_Unknown
678 };
679
685 FileStatus(sal_uInt32 nMask)
686 : _nMask(nMask)
687 {
688 memset(&_aStatus, 0, sizeof(_aStatus));
689 _aStatus.uStructSize = sizeof(_aStatus);
690 }
691
694 ~FileStatus()
695 {
696 if ( _aStatus.ustrFileURL )
697 rtl_uString_release( _aStatus.ustrFileURL );
698 if ( _aStatus.ustrLinkTargetURL )
699 rtl_uString_release( _aStatus.ustrLinkTargetURL );
700 if ( _aStatus.ustrFileName )
701 rtl_uString_release( _aStatus.ustrFileName );
702 }
703
713 inline bool isValid( sal_uInt32 nMask ) const
714 {
715 return ( nMask & _aStatus.uValidFields ) == nMask;
716 }
717
723 inline Type getFileType() const
724 {
725 SAL_INFO_IF(
726 !isValid(osl_FileStatus_Mask_Type), "sal.osl",
727 "no FileStatus Type determined");
728 return isValid(osl_FileStatus_Mask_Type)
729 ? static_cast< Type >(_aStatus.eType) : Unknown;
730 }
731
741 inline bool isDirectory() const
742 {
743 return ( getFileType() == Directory || getFileType() == Volume );
744 }
745
756 inline bool isRegular() const
757 {
758 return ( getFileType() == Regular );
759 }
760
769 inline bool isLink() const
770 {
771 return ( getFileType() == Link );
772 }
773
780 inline sal_uInt64 getAttributes() const
781 {
782 SAL_INFO_IF(
783 !isValid(osl_FileStatus_Mask_Attributes), "sal.osl",
784 "no FileStatus Attributes determined");
785 return _aStatus.uAttributes;
786 }
787
795 inline TimeValue getCreationTime() const
796 {
797 SAL_INFO_IF(
798 !isValid(osl_FileStatus_Mask_CreationTime), "sal.osl",
799 "no FileStatus CreationTime determined");
800 return _aStatus.aCreationTime;
801 }
802
810 inline TimeValue getAccessTime() const
811 {
812 SAL_INFO_IF(
813 !isValid(osl_FileStatus_Mask_AccessTime), "sal.osl",
814 "no FileStatus AccessTime determined");
815 return _aStatus.aAccessTime;
816 }
817
825 inline TimeValue getModifyTime() const
826 {
827 SAL_INFO_IF(
828 !isValid(osl_FileStatus_Mask_ModifyTime), "sal.osl",
829 "no FileStatus ModifyTime determined");
830 return _aStatus.aModifyTime;
831 }
832
839 inline sal_uInt64 getFileSize() const
840 {
841 SAL_INFO_IF(
842 !isValid(osl_FileStatus_Mask_FileSize), "sal.osl",
843 "no FileStatus FileSize determined");
844 return _aStatus.uFileSize;
845 }
846
853 inline ::rtl::OUString getFileName() const
854 {
855 SAL_INFO_IF(
856 !isValid(osl_FileStatus_Mask_FileName), "sal.osl",
857 "no FileStatus FileName determined");
858 return isValid(osl_FileStatus_Mask_FileName)
859 ? rtl::OUString(_aStatus.ustrFileName) : rtl::OUString();
860 }
861
862
870 inline ::rtl::OUString getFileURL() const
871 {
872 SAL_INFO_IF(
873 !isValid(osl_FileStatus_Mask_FileURL), "sal.osl",
874 "no FileStatus FileURL determined");
875 return isValid(osl_FileStatus_Mask_FileURL)
876 ? rtl::OUString(_aStatus.ustrFileURL) : rtl::OUString();
877 }
878
886 inline ::rtl::OUString getLinkTargetURL() const
887 {
888 SAL_INFO_IF(
889 !isValid(osl_FileStatus_Mask_LinkTargetURL), "sal.osl",
890 "no FileStatus LinkTargetURL determined");
891 return isValid(osl_FileStatus_Mask_LinkTargetURL)
892 ? rtl::OUString(_aStatus.ustrLinkTargetURL) : rtl::OUString();
893 }
894
895 friend class DirectoryItem;
896 };
897
898
899
906 class File: public FileBase
907 {
908 oslFileHandle _pData;
909 ::rtl::OUString _aPath;
910
914 File( File& );
915
919 File& operator = ( File& );
920
921 public:
922
929 File( const ::rtl::OUString& ustrFileURL ): _pData( 0 ), _aPath( ustrFileURL ) {}
930
934 inline ~File()
935 {
936 close();
937 }
938
946 inline rtl::OUString getURL() const { return _aPath; }
947
991 inline RC open( sal_uInt32 uFlags )
992 {
993 return static_cast< RC >( osl_openFile( _aPath.pData, &_pData, uFlags ) );
994 }
995
1010 inline RC close()
1011 {
1012 oslFileError Error = osl_File_E_BADF;
1013
1014 if( _pData )
1015 {
1016 Error=osl_closeFile( _pData );
1017 _pData = NULL;
1018 }
1019
1020 return static_cast< RC >( Error );
1021 }
1022
1040 inline RC setPos( sal_uInt32 uHow, sal_Int64 uPos ) SAL_WARN_UNUSED_RESULT
1041 {
1042 return static_cast< RC >( osl_setFilePos( _pData, uHow, uPos ) );
1043 }
1044
1061 inline RC getPos( sal_uInt64& uPos )
1062 {
1063 return static_cast< RC >( osl_getFilePos( _pData, &uPos ) );
1064 }
1065
1088 inline RC isEndOfFile( sal_Bool *pIsEOF )
1089 {
1090 return static_cast< RC >( osl_isEndOfFile( _pData, pIsEOF ) );
1091 }
1092
1111 inline RC setSize( sal_uInt64 uSize )
1112 {
1113 return static_cast< RC >( osl_setFileSize( _pData, uSize ) );
1114 }
1115
1136 inline RC getSize( sal_uInt64 &rSize )
1137 {
1138 return static_cast< RC >( osl_getFileSize( _pData, &rSize ) );
1139 }
1140
1173 inline RC read( void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64& rBytesRead )
1174 {
1175 return static_cast< RC >( osl_readFile( _pData, pBuffer, uBytesRequested, &rBytesRead ) );
1176 }
1177
1212 inline RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64& rBytesWritten)
1213 {
1214 return static_cast< RC >( osl_writeFile( _pData, pBuffer, uBytesToWrite, &rBytesWritten ) );
1215 }
1216
1217
1242 inline RC readLine( ::rtl::ByteSequence& aSeq )
1243 {
1244 return static_cast< RC >( osl_readLine( _pData, reinterpret_cast<sal_Sequence**>(&aSeq) ) );
1245 }
1246
1277 inline RC sync() const
1278 {
1279 OSL_PRECOND(_pData, "File::sync(): File not open");
1280 return static_cast< RC >(osl_syncFile(_pData));
1281 }
1282
1309 inline static RC copy( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1310 {
1311 return static_cast< RC >( osl_copyFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1312 }
1313
1338 inline static RC move( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1339 {
1340 return static_cast< RC >( osl_moveFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1341 }
1342
1371 inline static RC remove( const ::rtl::OUString& ustrFileURL )
1372 {
1373 return static_cast< RC >( osl_removeFile( ustrFileURL.pData ) );
1374 }
1375
1391 inline static RC setAttributes( const ::rtl::OUString& ustrFileURL, sal_uInt64 uAttributes )
1392 {
1393 return static_cast< RC >( osl_setFileAttributes( ustrFileURL.pData, uAttributes ) );
1394 }
1395
1418 inline static RC setTime(
1419 const ::rtl::OUString& ustrFileURL,
1420 const TimeValue& rCreationTime,
1421 const TimeValue& rLastAccessTime,
1422 const TimeValue& rLastWriteTime )
1423 {
1424 return static_cast< RC >( osl_setFileTime(
1425 ustrFileURL.pData,
1426 &rCreationTime,
1427 &rLastAccessTime,
1428 &rLastWriteTime ) );
1429 }
1430
1431 friend class DirectoryItem;
1432 };
1433
1434
1440 class DirectoryItem: public FileBase
1441 {
1442 oslDirectoryItem _pData;
1443
1444 public:
1445
1449 DirectoryItem(): _pData( NULL )
1450 {
1451 }
1452
1456 DirectoryItem( const DirectoryItem& rItem ): _pData( rItem._pData)
1457 {
1458 if( _pData )
1459 osl_acquireDirectoryItem( _pData );
1460 }
1461
1465 ~DirectoryItem()
1466 {
1467 if( _pData )
1468 osl_releaseDirectoryItem( _pData );
1469 }
1470
1474 DirectoryItem& operator=(const DirectoryItem& rItem )
1475 {
1476 if (&rItem != this)
1477 {
1478 if( _pData )
1479 osl_releaseDirectoryItem( _pData );
1480
1481 _pData = rItem._pData;
1482
1483 if( _pData )
1484 osl_acquireDirectoryItem( _pData );
1485 }
1486 return *this;
1487 }
1488
1495 inline bool is()
1496 {
1497 return _pData != NULL;
1498 }
1499
1534 static inline RC get( const ::rtl::OUString& ustrFileURL, DirectoryItem& rItem )
1535 {
1536 if( rItem._pData)
1537 {
1538 osl_releaseDirectoryItem( rItem._pData );
1539 rItem._pData = NULL;
1540 }
1541
1542 return static_cast< RC >( osl_getDirectoryItem( ustrFileURL.pData, &rItem._pData ) );
1543 }
1544
1577 inline RC getFileStatus( FileStatus& rStatus )
1578 {
1579 return static_cast< RC >( osl_getFileStatus( _pData, &rStatus._aStatus, rStatus._nMask ) );
1580 }
1581
1598 inline bool isIdenticalTo( const DirectoryItem &pOther )
1599 {
1600 return osl_identicalDirectoryItem( _pData, pOther._pData );
1601 }
1602
1603 friend class Directory;
1604 };
1605
1606
1607
1618 class DirectoryCreationObserver
1619 {
1620 public:
1621 virtual ~DirectoryCreationObserver() {}
1622
1632 virtual void DirectoryCreated(const rtl::OUString& aDirectoryUrl) = 0;
1633 };
1634
1635
1636 // This just an internal helper function for
1637 // private use.
1638 extern "C" inline void SAL_CALL onDirectoryCreated(void* pData, rtl_uString* aDirectoryUrl)
1639 {
1640 (static_cast<DirectoryCreationObserver*>(pData))->DirectoryCreated(aDirectoryUrl);
1641 }
1642
1649 class Directory: public FileBase
1650 {
1651 oslDirectory _pData;
1652 ::rtl::OUString _aPath;
1653
1657 Directory( Directory& );
1658
1662 Directory& operator = ( Directory& );
1663
1664 public:
1665
1673 Directory( const ::rtl::OUString& strPath ): _pData( 0 ), _aPath( strPath )
1674 {
1675 }
1676
1680 ~Directory()
1681 {
1682 close();
1683 }
1684
1692 inline rtl::OUString getURL() const { return _aPath; }
1693
1712 inline RC open()
1713 {
1714 return static_cast< RC >( osl_openDirectory( _aPath.pData, &_pData ) );
1715 }
1716
1728 inline bool isOpen() { return _pData != NULL; }
1729
1742 inline RC close()
1743 {
1744 oslFileError Error = osl_File_E_BADF;
1745
1746 if( _pData )
1747 {
1748 Error=osl_closeDirectory( _pData );
1749 _pData = NULL;
1750 }
1751
1752 return static_cast< RC >( Error );
1753 }
1754
1755
1773 inline RC reset()
1774 {
1775 close();
1776 return open();
1777 }
1778
1802 inline RC getNextItem( DirectoryItem& rItem, sal_uInt32 nHint = 0 )
1803 {
1804 if( rItem._pData )
1805 {
1806 osl_releaseDirectoryItem( rItem._pData );
1807 rItem._pData = 0;
1808 }
1809 return ( RC) osl_getNextDirectoryItem( _pData, &rItem._pData, nHint );
1810 }
1811
1812
1844 inline static RC getVolumeInfo( const ::rtl::OUString& ustrDirectoryURL, VolumeInfo& rInfo )
1845 {
1846 return static_cast< RC >( osl_getVolumeInformation( ustrDirectoryURL.pData, &rInfo._aInfo, rInfo._nMask ) );
1847 }
1848
1880 inline static RC create(
1881 const ::rtl::OUString& ustrDirectoryURL,
1882 sal_uInt32 flags = osl_File_OpenFlag_Read | osl_File_OpenFlag_Write )
1883 {
1884 return static_cast< RC >(
1885 osl_createDirectoryWithFlags( ustrDirectoryURL.pData, flags ) );
1886 }
1887
1916 inline static RC remove( const ::rtl::OUString& ustrDirectoryURL )
1917 {
1918 return static_cast< RC >( osl_removeDirectory( ustrDirectoryURL.pData ) );
1919 }
1920
1973 static RC createPath(
1974 const ::rtl::OUString& aDirectoryUrl,
1975 DirectoryCreationObserver* aDirectoryCreationObserver = NULL)
1976 {
1977 return static_cast< RC >(osl_createDirectoryPath(
1978 aDirectoryUrl.pData,
1979 (aDirectoryCreationObserver) ? onDirectoryCreated : NULL,
1980 aDirectoryCreationObserver));
1981 }
1982 };
1983
1984 } /* namespace osl */
1985
1986 #endif // INCLUDED_OSL_FILE_HXX
1987
1988 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
osl_File_E_NOTEMPTY
Definition: file.h:124
osl::FileBase::E_NOSPC
Definition: file.hxx:82
osl::FileBase::E_NOENT
Definition: file.hxx:58
osl_File_E_FBIG
Definition: file.h:112
osl_Volume_Attribute_RAMDisk
#define osl_Volume_Attribute_RAMDisk
Definition: file.h:542
osl::DirectoryItem::operator=
DirectoryItem & operator=(const DirectoryItem &rItem)
Assignment operator.
Definition: file.hxx:1474
osl::VolumeInfo::getFileSystemName
inline::rtl::OUString getFileSystemName() const
Determine the name of the volume device's File System.
Definition: file.hxx:600
osl_removeDirectory
SAL_DLLPUBLIC oslFileError osl_removeDirectory(rtl_uString *pustrDirectoryURL)
Remove an empty directory.
osl_FileStatus_Mask_LinkTargetURL
#define osl_FileStatus_Mask_LinkTargetURL
Definition: file.h:374
osl::FileBase::E_MLINK
Definition: file.hxx:85
osl_File_E_XDEV
Definition: file.h:104
osl::VolumeDevice::getMountPath
rtl::OUString getMountPath()
Get the full qualified URL where a device is mounted to.
Definition: file.hxx:391
osl::DirectoryItem::isIdenticalTo
bool isIdenticalTo(const DirectoryItem &pOther)
Determine if a directory item point the same underlying file.
Definition: file.hxx:1598
osl_createDirectoryPath
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath(rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
Create a directory path.
_oslVolumeInfo::uTotalSpace
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:576
osl_File_E_TIMEDOUT
Definition: file.h:133
sal_Bool
unsigned char sal_Bool
Definition: types.h:48
_oslVolumeInfo::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:572
osl::FileBase::E_RANGE
Definition: file.hxx:88
osl::FileStatus::FileStatus
FileStatus(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:685
osl::FileBase::E_None
Definition: file.hxx:56
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:190
osl_FileStatus_Mask_Type
#define osl_FileStatus_Mask_Type
Definition: file.h:366
osl::File::open
RC open(sal_uInt32 uFlags)
Open a regular file.
Definition: file.hxx:991
osl::FileStatus::getFileURL
inline::rtl::OUString getFileURL() const
Get the URL of the file.
Definition: file.hxx:870
osl_File_OpenFlag_Read
#define osl_File_OpenFlag_Read
Definition: file.h:638
osl_Volume_Attribute_Remote
#define osl_Volume_Attribute_Remote
Definition: file.h:539
osl::FileBase::E_MULTIHOP
Definition: file.hxx:97
osl_File_E_invalidError
Definition: file.h:132
osl::Directory::reset
RC reset()
Resets the directory item enumeration to the beginning.
Definition: file.hxx:1773
osl_File_E_2BIG
Definition: file.h:94
osl::FileStatus
The FileStatus class.
Definition: file.hxx:652
osl_setFileTime
SAL_DLLPUBLIC oslFileError osl_setFileTime(rtl_uString *pustrFileURL, const TimeValue *aCreationTime, const TimeValue *aLastAccessTime, const TimeValue *aLastWriteTime)
Set the file time.
rtl::ByteSequence
C++ class representing a SAL byte sequence.
Definition: byteseq.h:161
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:311
osl::File::getURL
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:946
osl::FileBase::E_NETWORK
Definition: file.hxx:103
osl_FileStatus_Mask_AccessTime
#define osl_FileStatus_Mask_AccessTime
Definition: file.h:369
_oslFileStatus::uStructSize
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:389
osl_File_E_NAMETOOLONG
Definition: file.h:121
_oslVolumeInfo::uMaxNameLength
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:582
osl_getFileURLFromSystemPath
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath(rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
Convert a system dependent path into a file URL.
osl::FileBase::E_NXIO
Definition: file.hxx:62
osl::FileBase::E_BUSY
Definition: file.hxx:71
osl_File_E_NFILE
Definition: file.h:109
osl::Directory::getNextItem
RC getNextItem(DirectoryItem &rItem, sal_uInt32 nHint=0)
Retrieve the next item of a previously opened directory.
Definition: file.hxx:1802
osl::FileBase::E_BADF
Definition: file.hxx:65
osl_FileStatus_Mask_FileSize
#define osl_FileStatus_Mask_FileSize
Definition: file.h:371
osl_File_E_DEADLK
Definition: file.h:120
osl::VolumeDevice::operator=
VolumeDevice & operator=(const VolumeDevice &rDevice)
Assignment operator.
Definition: file.hxx:371
osl_readLine
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
osl_File_E_PERM
Definition: file.h:88
osl_File_E_CHILD
Definition: file.h:97
osl::FileBase::E_NOLINK
Definition: file.hxx:96
osl_releaseVolumeDeviceHandle
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
osl::File::~File
~File()
Destructor.
Definition: file.hxx:934
osl::File::File
File(const ::rtl::OUString &ustrFileURL)
Constructor.
Definition: file.hxx:929
osl_FileStatus_Mask_Attributes
#define osl_FileStatus_Mask_Attributes
Definition: file.h:367
osl::FileStatus::getCreationTime
TimeValue getCreationTime() const
Get the creation time of this file.
Definition: file.hxx:795
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:130
osl::File::close
RC close()
Close an open file.
Definition: file.hxx:1010
osl::FileBase::getTempDirURL
static RC getTempDirURL(::rtl::OUString &ustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
Definition: file.hxx:258
osl_Volume_Attribute_Removeable
#define osl_Volume_Attribute_Removeable
Definition: file.h:538
_oslVolumeInfo::ustrFileSystemName
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:587
osl_File_E_MFILE
Definition: file.h:110
osl::VolumeInfo::getFixedDiskFlag
bool getFixedDiskFlag() const
Check the fixed disk flag.
Definition: file.hxx:517
osl::onDirectoryCreated
void onDirectoryCreated(void *pData, rtl_uString *aDirectoryUrl)
Definition: file.hxx:1638
osl::FileBase::E_FBIG
Definition: file.hxx:81
osl::File::setSize
RC setSize(sal_uInt64 uSize)
Set the file size of an open file.
Definition: file.hxx:1111
osl_getVolumeDeviceMountPath
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath(oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
Get the full qualified URL where a device is mounted to.
osl_getFileSize
SAL_DLLPUBLIC oslFileError osl_getFileSize(oslFileHandle Handle, sal_uInt64 *pSize)
Get the file size of an open file.
oslDirectory
void * oslDirectory
Definition: file.h:138
osl::VolumeInfo::getFreeSpace
sal_uInt64 getFreeSpace() const
Determine the free space of a volume device.
Definition: file.hxx:552
osl_createDirectoryWithFlags
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
oslVolumeInfo
struct _oslVolumeInfo oslVolumeInfo
osl_File_Type_Fifo
Definition: file.h:343
osl_File_E_AGAIN
Definition: file.h:98
osl::File::readLine
RC readLine(::rtl::ByteSequence &aSeq)
Read a line from a file.
Definition: file.hxx:1242
osl::FileBase::E_SPIPE
Definition: file.hxx:83
osl::File::getPos
RC getPos(sal_uInt64 &uPos)
Retrieve the current position of the internal pointer of an open file.
Definition: file.hxx:1061
osl::VolumeInfo::VolumeInfo
VolumeInfo(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:437
osl::FileStatus::getFileSize
sal_uInt64 getFileSize() const
Get the size of the file.
Definition: file.hxx:839
osl::FileStatus::getAccessTime
TimeValue getAccessTime() const
Get the file access time.
Definition: file.hxx:810
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:170
osl::FileStatus::isRegular
bool isRegular() const
Is it a regular file?
Definition: file.hxx:756
osl_File_E_RANGE
Definition: file.h:119
osl::VolumeInfo::getRemoteFlag
bool getRemoteFlag() const
Check the remote flag.
Definition: file.hxx:473
osl::Directory::Directory
Directory(const ::rtl::OUString &strPath)
Constructor.
Definition: file.hxx:1673
osl_Volume_Attribute_Case_Sensitive
#define osl_Volume_Attribute_Case_Sensitive
Definition: file.h:546
osl_File_E_NOTTY
Definition: file.h:111
osl::VolumeInfo::getFloppyDiskFlag
bool getFloppyDiskFlag() const
Check the floppy disc flag.
Definition: file.hxx:506
osl::FileBase::E_ISDIR
Definition: file.hxx:76
osl_File_E_NOLINK
Definition: file.h:127
osl_File_E_None
Definition: file.h:87
osl_Volume_Attribute_FloppyDisk
#define osl_Volume_Attribute_FloppyDisk
Definition: file.h:543
osl_closeFile
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
osl::VolumeDevice::VolumeDevice
VolumeDevice(const VolumeDevice &rDevice)
Copy constructor.
Definition: file.hxx:349
osl_File_E_MLINK
Definition: file.h:116
osl_getVolumeInformation
SAL_DLLPUBLIC oslFileError osl_getVolumeInformation(rtl_uString *pustrDirectoryURL, oslVolumeInfo *pInfo, sal_uInt32 uFieldMask)
Retrieve information about a volume.
osl::FileBase::E_LOOP
Definition: file.hxx:94
_oslFileStatus::uValidFields
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:391
osl::FileStatus::Type
Type
Definition: file.hxx:669
osl::File::isEndOfFile
RC isEndOfFile(sal_Bool *pIsEOF)
Test if the end of a file is reached.
Definition: file.hxx:1088
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::FileBase::E_NFILE
Definition: file.hxx:78
_oslFileStatus
Structure containing information about files and directories.
Definition: file.h:387
file.h
Main goals and usage hints.
osl_getNextDirectoryItem
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem(oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
Retrieve the next item of a previously opened directory.
log.hxx
osl_File_E_ACCES
Definition: file.h:100
osl_File_E_NOLCK
Definition: file.h:122
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:309
osl::FileBase::E_NAMETOOLONG
Definition: file.hxx:90
_oslFileStatus::uAttributes
sal_uInt64 uAttributes
File attributes.
Definition: file.h:395
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:1212
osl::FileBase::E_FAULT
Definition: file.hxx:70
osl_Volume_Attribute_FixedDisk
#define osl_Volume_Attribute_FixedDisk
Definition: file.h:541
osl::DirectoryItem::DirectoryItem
DirectoryItem(const DirectoryItem &rItem)
Copy constructor.
Definition: file.hxx:1456
string.h
_oslFileStatus::ustrFileURL
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:411
osl::FileBase::E_EXIST
Definition: file.hxx:72
_oslFileStatus::uFileSize
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:405
osl::FileBase::E_PERM
Definition: file.hxx:57
osl::VolumeDevice::VolumeDevice
VolumeDevice()
Constructor.
Definition: file.hxx:339
osl::DirectoryItem
The directory item class object provides access to file status information.
Definition: file.hxx:1440
osl::FileStatus::Special
Definition: file.hxx:676
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:1040
osl::FileBase::E_DOM
Definition: file.hxx:87
time.h
diagnose.h
osl::FileBase::E_INTR
Definition: file.hxx:60
osl_getTempDirURL
SAL_DLLPUBLIC oslFileError osl_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
osl::VolumeInfo
The VolumeInfo class.
Definition: file.hxx:413
osl_File_E_INVAL
Definition: file.h:108
osl::FileBase
Base class for all File System specific objects.
Definition: file.hxx:51
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:1338
osl_File_E_BADF
Definition: file.h:96
osl::FileBase::E_ACCES
Definition: file.hxx:69
osl::FileStatus::Link
Definition: file.hxx:675
OSL_PRECOND
#define OSL_PRECOND(c, m)
Definition: diagnose.h:111
osl::VolumeInfo::getMaxPathLength
sal_uInt32 getMaxPathLength() const
Determine the maximal length of a path name.
Definition: file.hxx:588
osl::FileBase::E_SRCH
Definition: file.hxx:59
osl::FileBase::E_ILSEQ
Definition: file.hxx:95
_oslVolumeInfo::uMaxPathLength
sal_uInt32 uMaxPathLength
Maximum length of a full quallified path in system notation.
Definition: file.h:584
osl_getFileStatus
SAL_DLLPUBLIC oslFileError osl_getFileStatus(oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask)
Retrieve information about a single file or directory.
_oslVolumeInfo::pDeviceHandle
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:589
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::VolumeInfo::getDeviceHandle
VolumeDevice getDeviceHandle() const
Get the volume device handle.
Definition: file.hxx:613
osl::DirectoryItem::~DirectoryItem
~DirectoryItem()
Destructor.
Definition: file.hxx:1465
_oslFileStatus::aAccessTime
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:401
osl::File::getSize
RC getSize(sal_uInt64 &rSize)
Get the file size of an open file.
Definition: file.hxx:1136
osl::VolumeInfo::getMaxNameLength
sal_uInt32 getMaxNameLength() const
Determine the maximal length of a file name.
Definition: file.hxx:576
osl_File_E_NOENT
Definition: file.h:89
osl_setFileSize
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
ustring.hxx
osl::FileBase::E_AGAIN
Definition: file.hxx:67
osl_getSystemPathFromFileURL
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
osl_File_E_SRCH
Definition: file.h:90
osl::FileBase::E_NOTEMPTY
Definition: file.hxx:93
osl::Directory::open
RC open()
Open a directory for enumerating its contents.
Definition: file.hxx:1712
osl_openDirectory
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
osl_File_E_LOOP
Definition: file.h:125
osl_File_E_NOSYS
Definition: file.h:123
osl::VolumeInfo::getCompactDiscFlag
bool getCompactDiscFlag() const
Check the compact disc flag.
Definition: file.hxx:495
osl::File::copy
static RC copy(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Copy a file to a new destination.
Definition: file.hxx:1309
osl_File_Type_Link
Definition: file.h:345
osl::FileBase::E_NOTTY
Definition: file.hxx:80
osl::FileStatus::getAttributes
sal_uInt64 getAttributes() const
Get the file attributes.
Definition: file.hxx:780
osl::VolumeInfo::isCasePreservingFileSystem
bool isCasePreservingFileSystem() const
Return whether the file system preserves the case of file and directory names or not.
Definition: file.hxx:636
osl::FileBase::E_NODEV
Definition: file.hxx:74
osl::VolumeInfo::isValid
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:462
oslDirectoryItem
void * oslDirectoryItem
Definition: file.h:139
osl_searchFileURL
SAL_DLLPUBLIC oslFileError osl_searchFileURL(rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL)
Searche a full qualified system path or a file URL.
osl_isEndOfFile
SAL_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.
osl::Directory::~Directory
~Directory()
Destructor.
Definition: file.hxx:1680
osl_openFile
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
oslVolumeDeviceHandle
void * oslVolumeDeviceHandle
Definition: file.h:462
osl::FileBase::E_NOTREADY
Definition: file.hxx:100
_oslVolumeInfo::uAttributes
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:574
osl::Directory::getURL
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:1692
_oslFileStatus::eType
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:393
osl_File_OpenFlag_Write
#define osl_File_OpenFlag_Write
Definition: file.h:639
osl_File_E_ILSEQ
Definition: file.h:126
osl::Directory::getVolumeInfo
static RC getVolumeInfo(const ::rtl::OUString &ustrDirectoryURL, VolumeInfo &rInfo)
Retrieve information about a volume.
Definition: file.hxx:1844
osl::FileStatus::isValid
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:713
osl_File_E_NOSPC
Definition: file.h:113
osl_File_E_EXIST
Definition: file.h:103
_oslVolumeInfo::uFreeSpace
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:580
osl_File_E_NOTREADY
Definition: file.h:131
osl::FileStatus::Volume
Definition: file.hxx:671
osl_setFileAttributes
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
osl::FileBase::E_invalidError
Definition: file.hxx:101
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:284
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::Directory::close
RC close()
Close a directory.
Definition: file.hxx:1742
osl::FileStatus::~FileStatus
~FileStatus()
Destructor.
Definition: file.hxx:694
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:210
oslFileError
oslFileError
Definition: file.h:86
osl::FileBase::E_NOTDIR
Definition: file.hxx:75
osl_FileStatus_Mask_FileName
#define osl_FileStatus_Mask_FileName
Definition: file.h:372
osl_getCanonicalName
SAL_DLLPUBLIC oslFileError osl_getCanonicalName(rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
Determine a valid unused canonical name for a requested name.
osl_File_E_IO
Definition: file.h:92
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:243
osl
Definition: conditn.hxx:28
osl_File_E_USERS
Definition: file.h:129
rtl_uString_release
SAL_DLLPUBLIC void rtl_uString_release(rtl_uString *str) SAL_THROW_EXTERN_C()
Decrement the reference count of a string.
osl_FileStatus_Mask_ModifyTime
#define osl_FileStatus_Mask_ModifyTime
Definition: file.h:370
osl_File_E_ROFS
Definition: file.h:115
osl_acquireVolumeDeviceHandle
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Acquire a volume device handle.
osl_File_Type_Special
Definition: file.h:346
osl::FileBase::E_NOSYS
Definition: file.hxx:92
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling...
Definition: ustring.hxx:81
osl_Volume_Attribute_CompactDisc
#define osl_Volume_Attribute_CompactDisc
Definition: file.h:540
osl_releaseDirectoryItem
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem(oslDirectoryItem Item)
Decrease the refcount of a directory item handle.
osl::FileBase::E_MFILE
Definition: file.hxx:79
osl::Directory::createPath
static RC createPath(const ::rtl::OUString &aDirectoryUrl, DirectoryCreationObserver *aDirectoryCreationObserver=NULL)
Create a directory path.
Definition: file.hxx:1973
osl_closeDirectory
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
osl::DirectoryCreationObserver::~DirectoryCreationObserver
virtual ~DirectoryCreationObserver()
Definition: file.hxx:1621
osl_Volume_Attribute_Case_Is_Preserved
#define osl_Volume_Attribute_Case_Is_Preserved
Definition: file.h:545
osl::VolumeInfo::getRAMDiskFlag
bool getRAMDiskFlag() const
Check the RAM disk flag.
Definition: file.hxx:528
osl::FileBase::RC
RC
Definition: file.hxx:55
osl::FileStatus::Fifo
Definition: file.hxx:673
TimeValue
Definition: time.h:42
byteseq.hxx
osl_identicalDirectoryItem
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem(oslDirectoryItem pItemA, oslDirectoryItem pItemB)
Determine if two directory items point the same underlying file.
_oslFileStatus::aModifyTime
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:403
osl::DirectoryItem::is
bool is()
Check for validity of this instance.
Definition: file.hxx:1495
osl_File_E_NXIO
Definition: file.h:93
osl_File_Type_Volume
Definition: file.h:341
osl::Directory::isOpen
bool isOpen()
Query if directory is open.
Definition: file.hxx:1728
osl_File_E_PIPE
Definition: file.h:117
osl::FileBase::E_XDEV
Definition: file.hxx:73
_oslVolumeInfo::uUsedSpace
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:578
osl::DirectoryCreationObserver
Base class for observers of directory creation notifications.
Definition: file.hxx:1618
oslFileHandle
void * oslFileHandle
Definition: file.h:634
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::DirectoryItem::DirectoryItem
DirectoryItem()
Constructor.
Definition: file.hxx:1449
osl::VolumeInfo::getUsedSpace
sal_uInt64 getUsedSpace() const
Determine the used space of a volume device.
Definition: file.hxx:564
osl_acquireDirectoryItem
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
osl::FileBase::E_CHILD
Definition: file.hxx:66
osl::FileBase::E_TIMEDOUT
Definition: file.hxx:102
osl::VolumeInfo::isCaseSensitiveFileSystem
bool isCaseSensitiveFileSystem() const
Return whether the file system is case sensitive or case insensitive.
Definition: file.hxx:624
osl_File_E_INTR
Definition: file.h:91
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::VolumeDevice
The VolumeDevice class.
Definition: file.hxx:330
osl::FileBase::E_2BIG
Definition: file.hxx:63
_oslFileStatus::ustrLinkTargetURL
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:415
osl_syncFile
SAL_DLLPUBLIC oslFileError osl_syncFile(oslFileHandle Handle)
Synchronize the memory representation of a file with that on the physical medium. ...
osl::FileBase::E_OVERFLOW
Definition: file.hxx:99
osl_File_E_ISDIR
Definition: file.h:107
_oslFileStatus::aCreationTime
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:398
osl_File_E_NOMEM
Definition: file.h:99
osl_File_E_MULTIHOP
Definition: file.h:128
osl::File
The file class object provides access to file contents and attributes.
Definition: file.hxx:906
osl::FileStatus::isLink
bool isLink() const
Is it a link?
Definition: file.hxx:769
osl_removeFile
SAL_DLLPUBLIC oslFileError osl_removeFile(rtl_uString *pustrFileURL)
Remove a regular file.
osl::FileStatus::isDirectory
bool isDirectory() const
Is it a directory? This method returns True for both directories, and volumes.
Definition: file.hxx:741
osl_getDirectoryItem
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem(rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
Retrieve a single directory item.
_oslFileStatus::ustrFileName
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:408
osl_FileStatus_Mask_CreationTime
#define osl_FileStatus_Mask_CreationTime
Definition: file.h:368
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:1418
_oslVolumeInfo::uStructSize
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:570
osl::FileStatus::getLinkTargetURL
inline::rtl::OUString getLinkTargetURL() const
Get the link target URL.
Definition: file.hxx:886
osl_File_Type_Regular
Definition: file.h:342
osl_File_E_BUSY
Definition: file.h:102
osl::FileStatus::Unknown
Definition: file.hxx:677
osl_File_Type_Directory
Definition: file.h:340
osl::FileStatus::Regular
Definition: file.hxx:672
osl::FileBase::E_INVAL
Definition: file.hxx:77
osl_File_E_SPIPE
Definition: file.h:114
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_File_E_NOEXEC
Definition: file.h:95
osl::FileBase::E_IO
Definition: file.hxx:61
osl::FileBase::E_NOLCK
Definition: file.hxx:91
osl_File_E_FAULT
Definition: file.h:101
osl_File_E_OVERFLOW
Definition: file.h:130
osl::DirectoryItem::getFileStatus
RC getFileStatus(FileStatus &rStatus)
Retrieve information about a single file or directory.
Definition: file.hxx:1577
osl_File_E_NODEV
Definition: file.h:105
osl::VolumeDevice::~VolumeDevice
~VolumeDevice()
Destructor.
Definition: file.hxx:359
osl::FileBase::E_ROFS
Definition: file.hxx:84
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:1880
osl::File::read
RC read(void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 &rBytesRead)
Read a number of bytes from a file.
Definition: file.hxx:1173
osl::VolumeInfo::getRemoveableFlag
bool getRemoveableFlag() const
Check the removeable flag.
Definition: file.hxx:484
config.h
osl_FileStatus_Mask_FileURL
#define osl_FileStatus_Mask_FileURL
Definition: file.h:373
osl::VolumeInfo::~VolumeInfo
~VolumeInfo()
Destructor.
Definition: file.hxx:448
osl::FileBase::E_PIPE
Definition: file.hxx:86
osl::FileBase::E_DEADLK
Definition: file.hxx:89
osl_File_E_NETWORK
Definition: file.h:134
osl::FileStatus::getModifyTime
TimeValue getModifyTime() const
Get the file modification time.
Definition: file.hxx:825
osl::FileStatus::getFileType
Type getFileType() const
Get the file type.
Definition: file.hxx:723
osl::FileBase::E_USERS
Definition: file.hxx:98
osl::FileBase::E_NOMEM
Definition: file.hxx:68
osl::Socket
Definition: socket_decl.hxx:162
osl_File_E_DOM
Definition: file.h:118
osl::VolumeInfo::getTotalSpace
sal_uInt64 getTotalSpace() const
Determine the total space of a volume device.
Definition: file.hxx:540
osl::File::sync
RC sync() const
Synchronize the memory representation of a file with that on the physical medium. ...
Definition: file.hxx:1277
osl::Directory
The directory class object provides a enumeration of DirectoryItems.
Definition: file.hxx:1649
osl::FileStatus::getFileName
inline::rtl::OUString getFileName() const
Get the file name.
Definition: file.hxx:853
osl::File::setAttributes
static RC setAttributes(const ::rtl::OUString &ustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
Definition: file.hxx:1391
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_NOEXEC
Definition: file.hxx:64
osl_File_Type_Unknown
Definition: file.h:347
osl_copyFile
SAL_DLLPUBLIC oslFileError osl_copyFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Copy a file to a new destination.
osl_File_Type_Socket
Definition: file.h:344
osl_getAbsoluteFileURL
SAL_DLLPUBLIC oslFileError osl_getAbsoluteFileURL(rtl_uString *pustrBaseDirectoryURL, rtl_uString *pustrRelativeFileURL, rtl_uString **ppustrAbsoluteFileURL)
Convert a path relative to a given directory into an full qualified file URL.
_oslVolumeInfo
Structure containing information about volumes.
Definition: file.h:568
osl_File_E_NOTDIR
Definition: file.h:106