LibreOffice: osl/file.hxx Source File

LibreOffice LibreOffice 26.2 SDK C/C++ API Reference

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