4 #ifndef INCLUDED_OSL_FILE_HXX
5 #define INCLUDED_OSL_FILE_HXX
20 namespace rtl {
class ByteSequence; }
291 rtl_uString* pustr_dir_url = pustrDirectoryURL ? pustrDirectoryURL->
pData : NULL;
292 rtl_uString** ppustr_tmp_file_url = pustrTempFileURL ? &pustrTempFileURL->
pData : NULL;
325 _aHandle = rDevice._aHandle;
355 _aHandle = newHandle;
654 memset(&_aStatus, 0,
sizeof(_aStatus));
693 "no FileStatus Type determined");
750 "no FileStatus Attributes determined");
765 "no FileStatus CreationTime determined");
780 "no FileStatus AccessTime determined");
795 "no FileStatus ModifyTime determined");
809 "no FileStatus FileSize determined");
823 "no FileStatus FileName determined");
840 "no FileStatus FileURL determined");
856 "no FileStatus LinkTargetURL determined");
894 File( const ::rtl::OUString& ustrFileURL ): _pData( NULL ), _aPath( ustrFileURL ) {}
983 return static_cast< RC >( Error );
1130 RC read(
void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64& rBytesRead )
1132 return static_cast< RC >(
osl_readFile( _pData, pBuffer, uBytesRequested, &rBytesRead ) );
1168 RC write(
const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64& rBytesWritten)
1170 return static_cast< RC >(
osl_writeFile( _pData, pBuffer, uBytesToWrite, &rBytesWritten ) );
1199 return static_cast< RC >(
osl_readLine( _pData, reinterpret_cast<sal_Sequence**>(&aSeq) ) );
1223 OSL_PRECOND(_pData,
"File::sync(): File not open");
1252 static RC copy( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1254 return static_cast< RC >(
osl_copyFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1280 static RC move( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1282 return static_cast< RC >(
osl_moveFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1313 const ::rtl::OUString& ustrDestFileURL)
1315 return static_cast<RC>(
osl_replaceFile(ustrSourceFileURL.pData, ustrDestFileURL.pData));
1344 static RC remove( const ::rtl::OUString& ustrFileURL )
1391 const ::rtl::OUString& ustrFileURL,
1400 &rLastWriteTime ) );
1453 _pData = rItem._pData;
1469 return _pData != NULL;
1510 rItem._pData = NULL;
1549 return static_cast< RC >(
osl_getFileStatus( _pData, &rStatus._aStatus, rStatus._nMask ) );
1641 Directory( const ::rtl::OUString& strPath ): _pData( NULL ), _aPath( strPath )
1717 return static_cast< RC >( Error );
1770 rItem._pData = NULL;
1842 const ::rtl::OUString& ustrDirectoryURL,
1845 return static_cast< RC >(
1875 static RC remove( const ::rtl::OUString& ustrDirectoryURL )
1917 const ::rtl::OUString& aDirectoryUrl,
1921 aDirectoryUrl.pData,
1923 aDirectoryCreationObserver));
1929 #endif // INCLUDED_OSL_FILE_HXX
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:557
RC getNextItem(DirectoryItem &rItem, sal_uInt32 nHint=0)
Retrieve the next item of a previously opened directory.
Definition: file.hxx:1765
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:549
::rtl::OUString getLinkTargetURL() const
Get the link target URL.
Definition: file.hxx:852
wrong device type specified
Definition: file.hxx:56
::rtl::OUString getFileName() const
Get the file name.
Definition: file.hxx:819
inappropriate I/O control operation
Definition: file.hxx:62
resource temp unavailable, try again later
Definition: file.hxx:49
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Acquire a volume device handle.
sal_uInt32 getMaxPathLength() const
Determine the maximal length of a path name.
Definition: file.hxx:554
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
~FileStatus()
Destructor.
Definition: file.hxx:660
filename too long
Definition: file.hxx:72
sal_uInt32 uMaxPathLength
Maximum length of a full qualified path in system notation.
Definition: file.h:561
there are no child processes
Definition: file.hxx:48
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:559
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:1280
Time since Jan-01-1970.
Definition: time.h:56
value too large for defined data type
Definition: file.hxx:81
device not ready
Definition: file.hxx:82
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:547
bad address; an invalid pointer detected
Definition: file.hxx:52
sal_uInt64 getTotalSpace() const
Determine the total space of a volume device.
Definition: file.hxx:506
bool getFixedDiskFlag() const
Check the fixed disk flag.
Definition: file.hxx:483
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
SAL_DLLPUBLIC oslFileError osl_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
unsigned char sal_Bool
Definition: types.h:18
bool isLink() const
Is it a link?
Definition: file.hxx:735
SAL_DLLPUBLIC oslFileError osl_getFilePos(oslFileHandle Handle, sal_uInt64 *pPos)
Retrieve the current position of the internal pointer of an open file.
SAL_DLLPUBLIC oslFileError osl_getVolumeInformation(rtl_uString *pustrDirectoryURL, oslVolumeInfo *pInfo, sal_uInt32 uFieldMask)
Retrieve information about a volume.
SAL_DLLPUBLIC oslFileError osl_getCanonicalName(rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
Determine a valid unused canonical name for a requested name.
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem(oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
Retrieve the next item of a previously opened directory.
TimeValue getModifyTime() const
Get the file modification time.
Definition: file.hxx:791
The VolumeDevice class.
Definition: file.hxx:304
struct _oslVolumeInfo oslVolumeInfo
Structure containing information about volumes.
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function...
Definition: file.h:364
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:380
#define osl_FileStatus_Mask_FileSize
Definition: file.h:349
SAL_DLLPUBLIC oslFileError osl_setFileTime(rtl_uString *pustrFileURL, const TimeValue *aCreationTime, const TimeValue *aLastAccessTime, const TimeValue *aLastWriteTime)
Set the file time.
~Directory()
Destructor.
Definition: file.hxx:1648
RC open()
Open a directory for enumerating its contents.
Definition: file.hxx:1679
The directory item class object provides access to file status information.
Definition: file.hxx:1412
I/O error occurred.
Definition: file.hxx:43
no process matches the PID
Definition: file.hxx:41
function not implemented
Definition: file.hxx:74
This String class provides base functionality for C++ like Unicode character array handling...
Definition: ustring.hxx:182
static RC setTime(const ::rtl::OUString &ustrFileURL, const TimeValue &rCreationTime, const TimeValue &rLastAccessTime, const TimeValue &rLastWriteTime)
Set the file time.
Definition: file.hxx:1390
improper link across file systems detected
Definition: file.hxx:55
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
void * oslFileHandle
Definition: file.h:610
rtl::OUString getMountPath()
Get the full qualified URL where a device is mounted to.
Definition: file.hxx:365
#define osl_FileStatus_Mask_Attributes
Definition: file.h:345
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:565
#define OSL_PRECOND(c, m)
Check the precondition of functions.
Definition: diagnose.h:92
bool getRAMDiskFlag() const
Check the RAM disk flag.
Definition: file.hxx:494
#define osl_Volume_Attribute_CompactDisc
Definition: file.h:510
bool isCaseSensitiveFileSystem() const
Return whether the file system is case sensitive or case insensitive.
Definition: file.hxx:590
no such file or directory
Definition: file.hxx:40
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:679
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath(oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
Get the full qualified URL where a device is mounted to.
RC getFileStatus(FileStatus &rStatus)
Retrieve information about a single file or directory.
Definition: file.hxx:1547
unmapped error: always last entry in enum!
Definition: file.hxx:83
~VolumeDevice()
Destructor.
Definition: file.hxx:333
argument list too long
Definition: file.hxx:45
bool is()
Check for validity of this instance.
Definition: file.hxx:1467
SAL_DLLPUBLIC oslFileError osl_syncFile(oslFileHandle Handle)
Synchronize the memory representation of a file with that on the physical medium. ...
RC sync() const
Synchronize the memory representation of a file with that on the physical medium. ...
Definition: file.hxx:1221
SAL_DLLPUBLIC oslFileError osl_readFile(oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead)
Read a number of bytes from a file.
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.
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:551
on success
Definition: file.hxx:38
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:568
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:1660
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...
SAL_DLLPUBLIC void rtl_uString_release(rtl_uString *str) SAL_THROW_EXTERN_C() SAL_HOT
Decrement the reference count of a string.
The FileStatus class.
Definition: file.hxx:618
static RC create(const ::rtl::OUString &ustrDirectoryURL, sal_uInt32 flags=osl_File_OpenFlag_Read|osl_File_OpenFlag_Write)
Create a directory.
Definition: file.hxx:1841
invalid argument to library function
Definition: file.hxx:59
#define SAL_INFO_IF(condition, area, stream)
Produce log entry from stream in the given log area if condition is true.
Definition: log.hxx:353
#define osl_Volume_Attribute_FixedDisk
Definition: file.h:511
illegal modification to read-only filesystem
Definition: file.hxx:66
Base class for observers of directory creation notifications.
Definition: file.hxx:1586
#define osl_FileStatus_Mask_AccessTime
Definition: file.h:347
SAL_DLLPUBLIC oslFileError osl_getFileSize(oslFileHandle Handle, sal_uInt64 *pSize)
Get the file size of an open file.
Directory(const ::rtl::OUString &strPath)
Constructor.
Definition: file.hxx:1641
bool getRemoveableFlag() const
Check the removable flag.
Definition: file.hxx:450
process has too many distinct files open
Definition: file.hxx:61
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem(oslDirectoryItem pItemA, oslDirectoryItem pItemB)
Determine if two directory items point the same underlying file.
DirectoryItem & operator=(const DirectoryItem &rItem)
Assignment operator.
Definition: file.hxx:1446
no locks available
Definition: file.hxx:73
resource busy
Definition: file.hxx:53
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem(oslDirectoryItem Item)
Decrease the refcount of a directory item handle.
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:386
bool isIdenticalTo(const DirectoryItem &pOther)
Determine if a directory item point the same underlying file.
Definition: file.hxx:1567
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...
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:376
broken pipe; no process reading from other end of pipe
Definition: file.hxx:68
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:911
pData
Definition: ustring.hxx:334
socket operation timed out
Definition: file.hxx:84
file too large
Definition: file.hxx:63
Type
Definition: file.hxx:635
void * oslDirectory
Definition: file.h:123
invalid executable file format
Definition: file.hxx:46
too many links to file
Definition: file.hxx:67
bool isRegular() const
Is it a regular file?
Definition: file.hxx:722
#define osl_Volume_Attribute_FloppyDisk
Definition: file.h:513
#define osl_File_OpenFlag_Read
Definition: file.h:614
~File()
Destructor.
Definition: file.hxx:899
VolumeDevice(const VolumeDevice &rDevice)
Copy constructor.
Definition: file.hxx:323
invalid seek operation (such as on pipe)
Definition: file.hxx:65
DirectoryItem()
Constructor.
Definition: file.hxx:1421
File(const ::rtl::OUString &ustrFileURL)
Constructor.
Definition: file.hxx:894
static RC getCanonicalName(const ::rtl::OUString &ustrRequestedURL,::rtl::OUString &ustrValidURL)
Determine a valid unused canonical name for a requested name.
Definition: file.hxx:111
RC read(void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 &rBytesRead)
Read a number of bytes from a file.
Definition: file.hxx:1130
RC
Definition: file.hxx:37
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:366
file is a directory, invalid operation
Definition: file.hxx:58
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:390
#define osl_Volume_Attribute_Remote
Definition: file.h:509
SAL_DLLPUBLIC oslFileError osl_removeDirectory(rtl_uString *pustrDirectoryURL)
Remove an empty directory.
#define osl_Volume_Attribute_Removeable
Definition: file.h:508
bool isOpen()
Query if directory is open.
Definition: file.hxx:1694
SAL_DLLPUBLIC oslFileError osl_writeFile(oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten)
Write a number of bytes to a file.
RC reset()
Resets the directory item enumeration to the beginning.
Definition: file.hxx:1737
#define osl_Volume_Attribute_Case_Is_Preserved
Definition: file.h:515
range error (mathematical error)
Definition: file.hxx:70
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
#define SAL_WARN_UNUSED_RESULT
Use this as markup for functions and methods whose return value must be checked.
Definition: types.h:264
bool getRemoteFlag() const
Check the remote flag.
Definition: file.hxx:440
remote resource is not directly available
Definition: file.hxx:79
sal_uInt64 uAttributes
File attributes.
Definition: file.h:370
void * oslDirectoryItem
Definition: file.h:124
sal_uInt64 getFileSize() const
Get the size of the file.
Definition: file.hxx:805
bool isCasePreservingFileSystem() const
Return whether the file system preserves the case of file and directory names or not.
Definition: file.hxx:602
#define osl_FileStatus_Mask_ModifyTime
Definition: file.h:348
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem(rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
Retrieve a single directory item.
static RC setAttributes(const ::rtl::OUString &ustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
Definition: file.hxx:1364
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:430
SAL_DLLPUBLIC oslFileError osl_copyFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Copy a file to a new destination.
no such device or address
Definition: file.hxx:44
bool getFloppyDiskFlag() const
Check the floppy disc flag.
Definition: file.hxx:472
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:555
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:368
bad file descriptor
Definition: file.hxx:47
#define osl_Volume_Attribute_Case_Sensitive
Definition: file.h:516
static RC createPath(const ::rtl::OUString &aDirectoryUrl, DirectoryCreationObserver *aDirectoryCreationObserver=NULL)
Create a directory path.
Definition: file.hxx:1916
TimeValue getCreationTime() const
Get the creation time of this file.
Definition: file.hxx:761
too many distinct file openings
Definition: file.hxx:60
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:1312
SAL_DLLPUBLIC oslFileError osl_searchFileURL(rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL)
Search a full qualified system path or a file URL.
#define osl_FileStatus_Mask_FileName
Definition: file.h:350
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
no memory available
Definition: file.hxx:50
deadlock avoided
Definition: file.hxx:71
file quote system is confused as there are too many users
Definition: file.hxx:80
#define osl_FileStatus_Mask_LinkTargetURL
Definition: file.h:352
#define osl_FileStatus_Mask_FileURL
Definition: file.h:351
void onDirectoryCreated(void *pData, rtl_uString *aDirectoryUrl)
Definition: file.hxx:1606
RC close()
Close a directory.
Definition: file.hxx:1707
SAL_WARN_UNUSED_RESULT RC setPos(sal_uInt32 uHow, sal_Int64 uPos)
Set the internal position pointer of an open file.
Definition: file.hxx:1002
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:378
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
operation not permitted
Definition: file.hxx:39
RC isEndOfFile(sal_Bool *pIsEOF)
Test if the end of a file is reached.
Definition: file.hxx:1048
RC open(sal_uInt32 uFlags)
Open a regular file.
Definition: file.hxx:955
sal_uInt64 getFreeSpace() const
Determine the free space of a volume device.
Definition: file.hxx:518
oslFileError
Definition: file.h:69
function call was interrupted
Definition: file.hxx:42
SAL_DLLPUBLIC oslFileError osl_moveFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Move a file or directory to a new destination or renames it.
#define osl_FileStatus_Mask_Type
Definition: file.h:344
static RC getFileURLFromSystemPath(const ::rtl::OUString &ustrSystemPath,::rtl::OUString &ustrFileURL)
Convert a system dependent path into a file URL.
Definition: file.hxx:188
sal_uInt32 getMaxNameLength() const
Determine the maximal length of a file name.
Definition: file.hxx:542
no space left on device, write failed
Definition: file.hxx:64
Base class for all File System specific objects.
Definition: file.hxx:33
C++ class representing a SAL byte sequence.
Definition: byteseq.h:149
VolumeDevice & operator=(const VolumeDevice &rDevice)
Assignment operator.
Definition: file.hxx:345
RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 &rBytesWritten)
Write a number of bytes to a file.
Definition: file.hxx:1168
file permissions do not allow operation
Definition: file.hxx:51
SAL_DLLPUBLIC oslFileError osl_getFileStatus(oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask)
Retrieve information about a single file or directory.
virtual ~DirectoryCreationObserver()
Definition: file.hxx:1589
sal_uInt64 getAttributes() const
Get the file attributes.
Definition: file.hxx:746
::rtl::OUString getFileURL() const
Get the URL of the file.
Definition: file.hxx:836
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
The directory class object provides an enumeration of DirectoryItems.
Definition: file.hxx:1617
Type getFileType() const
Get the file type.
Definition: file.hxx:689
invalid or incomplete byte sequence of multibyte char found
Definition: file.hxx:77
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).
Structure containing information about volumes.
Definition: file.h:544
Provides simple diagnostic support.
::rtl::OUString getFileSystemName() const
Determine the name of the volume device's File System.
Definition: file.hxx:566
#define osl_FileStatus_Mask_CreationTime
Definition: file.h:346
static RC getVolumeInfo(const ::rtl::OUString &ustrDirectoryURL, VolumeInfo &rInfo)
Retrieve information about a volume.
Definition: file.hxx:1806
directory not empty
Definition: file.hxx:75
VolumeDevice()
Constructor.
Definition: file.hxx:313
~VolumeInfo()
Definition: file.hxx:417
VolumeDevice getDeviceHandle() const
Get the volume device handle.
Definition: file.hxx:579
too many levels of symbolic links found during name lookup
Definition: file.hxx:76
VolumeInfo(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:409
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.
RC close()
Close an open file.
Definition: file.hxx:973
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:373
RC setSize(sal_uInt64 uSize)
Set the file size of an open file.
Definition: file.hxx:1070
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath(rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
Convert a system dependent path into a file URL.
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath(rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
Create a directory path.
#define osl_File_OpenFlag_Write
Definition: file.h:615
RC getSize(sal_uInt64 &rSize)
Get the file size of an open file.
Definition: file.hxx:1094
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
link has been severed
Definition: file.hxx:78
file exists where should only be created
Definition: file.hxx:54
RC readLine(::rtl::ByteSequence &aSeq)
Read a line from a file.
Definition: file.hxx:1197
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:383
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
RC getPos(sal_uInt64 &uPos)
Retrieve the current position of the internal pointer of an open file.
Definition: file.hxx:1022
static RC copy(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Copy a file to a new destination.
Definition: file.hxx:1252
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:286
#define osl_Volume_Attribute_RAMDisk
Definition: file.h:512
Definition: socket_decl.hxx:177
~DirectoryItem()
Destructor.
Definition: file.hxx:1437
SAL_DLLPUBLIC oslFileError osl_removeFile(rtl_uString *pustrFileURL)
Remove a regular file.
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:553
file isn't a directory where one is needed
Definition: file.hxx:57
The VolumeInfo class.
Definition: file.hxx:386
bool isDirectory() const
Is it a directory? This method returns True for both directories, and volumes.
Definition: file.hxx:707
domain error (mathematical error)
Definition: file.hxx:69
The file class object provides access to file contents and attributes.
Definition: file.hxx:871
bool getCompactDiscFlag() const
Check the compact disc flag.
Definition: file.hxx:461
FileStatus(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:651
static RC getSystemPathFromFileURL(const ::rtl::OUString &ustrFileURL,::rtl::OUString &ustrSystemPath)
Convert a file URL into a system dependent path.
Definition: file.hxx:169
DirectoryItem(const DirectoryItem &rItem)
Copy constructor.
Definition: file.hxx:1428
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:150
void * oslVolumeDeviceHandle
Definition: file.h:434
sal_uInt64 getUsedSpace() const
Determine the used space of a volume device.
Definition: file.hxx:530
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:358
SAL_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.
Structure containing information about files and directories.
Definition: file.h:362
static RC getTempDirURL(::rtl::OUString &ustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
Definition: file.hxx:234
TimeValue getAccessTime() const
Get the file access time.
Definition: file.hxx:776
Main goals and usage hints.
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:220