Overview | Namespace | Class | Index | Help |
File & | ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | NO |
Copy constructor.
File & | ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | NO | NO |
Assginment operator.
const ::rtl::OUString & | ustrFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Constructor.
ustrFileURL | The full qualified URL of the file. Relative paths are not allowed. |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Destructor
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Close an open file.
E_None on success E_INVAL the format of the parameters was not valid E_BADF Bad file E_INTR function call was interrupted E_NOLINK link has been severed E_NOSPC no space left on device E_IO on I/O errors
sal_uInt32 | uHow, |
sal_Int64 | uPos ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Set the internal position pointer of an open file.
uHow | Distance to move the internal position pointer (from uPos). |
uPos | Absolute position from the beginning of the file. |
E_None on success E_INVAL the format of the parameters was not valid E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files
sal_uInt64 & | uPos ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Retrieve the current position of the internal pointer of an open file.
uPos | On success receives the current position of the file pointer. |
E_None on success E_INVAL the format of the parameters was not valid E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files
sal_Bool * | pIsEOF ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Test if the end of a file is reached.
pIsEOF | Points to a variable that receives the end-of-file status. |
E_None on success E_INVAL the format of the parameters was not valid E_INTR function call was interrupted E_IO on I/O errors E_ISDIR is a directory E_BADF bad file E_FAULT bad address E_AGAIN operation would block E_NOLINK link has been severed
sal_uInt64 | uSize ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Set the file size of an open file.
Sets the file size of an open file. The file can be truncated or enlarged by the function. The position of the file pointer is not affeced by this function.
uSize | New size in bytes. |
E_None on success E_INVAL the format of the parameters was not valid E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files
void * | pBuffer, |
sal_uInt64 | uBytesRequested, |
sal_uInt64 & | rBytesRead ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Read a number of bytes from a file.
Reads a number of bytes from a file. The internal file pointer is increased by the number of bytes read.
pBuffer | Points to a buffer which receives data. The buffer must be large enough to hold uBytesRequested bytes. |
uBytesRequested | Number of bytes which should be retrieved. |
rBytesRead | On success the number of bytes which have actually been retrieved. |
E_None on success E_INVAL the format of the parameters was not valid E_INTR function call was interrupted E_IO on I/O errors E_ISDIR is a directory E_BADF bad file E_FAULT bad address E_AGAIN operation would block E_NOLINK link has been severed
const void * | pBuffer, |
sal_uInt64 | uBytesToWrite, |
sal_uInt64 & | rBytesWritten ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Write a number of bytes to a file.
Writes a number of bytes to a file. The internal file pointer is increased by the number of bytes read.
pBuffer | Points to a buffer which contains the data. |
uBytesToWrite | Number of bytes which should be written. |
rBytesWritten | On success the number of bytes which have actually been written. |
E_None on success E_INVAL the format of the parameters was not valid E_FBIG file too large E_DQUOT quota exceeded E_AGAIN operation would block E_BADF bad file E_FAULT bad address E_INTR function call was interrupted E_IO on I/O errosr E_NOLCK no record locks available E_NOLINK link has been severed E_NOSPC no space left on device E_NXIO no such device or address
::rtl::ByteSequence & | aSeq ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | NO | YES | NO |
Read a line from a file.
Reads a line from a file. The new line delimiter is NOT returned!
aSeq | A reference to a ::rtl::ByteSequence that will hold the line read on success. |
E_None on success E_INVAL the format of the parameters was not valid E_INTR function call was interrupted E_IO on I/O errors E_ISDIR is a directory E_BADF bad file E_FAULT bad address E_AGAIN operation would block E_NOLINK link has been severed
const ::rtl::OUString & | ustrSourceFileURL, |
const ::rtl::OUString & | ustrDestFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | YES | YES | NO |
Copy a file to a new destination.
Copies a file to a new destination. Copies only files not directories. No assumptions should be made about preserving attributes or file time.
ustrSourceFileURL | Full qualified URL of the source file. |
ustrDestFileURL | Full qualified URL of the destination file. A directory is NOT a valid destination file! |
E_None on success E_INVAL the format of the parameters was not valid E_NOMEM not enough memory for allocating structures E_ACCES permission denied E_PERM operation not permitted E_NAMETOOLONG file name too long E_NOENT no such file or directory E_ISDIR is a directory E_ROFS read-only file system
const ::rtl::OUString & | ustrSourceFileURL, |
const ::rtl::OUString & | ustrDestFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | YES | YES | NO |
Move a file or directory to a new destination or renames it.
Moves a file or directory to a new destination or renames it. File time and attributes are preserved.
ustrSourceFileURL | Full qualified URL of the source file. |
ustrDestFileURL | Full qualified URL of the destination file. An existing directory is NOT a valid destination ! |
E_None on success E_INVAL the format of the parameters was not valid E_NOMEM not enough memory for allocating structures E_ACCES permission denied E_PERM operation not permitted E_NAMETOOLONG file name too long E_NOENT no such file or directory E_ROFS read-only file system
const ::rtl::OUString & | ustrFileURL ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | YES | YES | NO |
Remove a regular file.
ustrFileURL | Full qualified URL of the file to remove. |
E_None on success E_INVAL the format of the parameters was not valid E_NOMEM not enough memory for allocating structures E_ACCES permission denied E_PERM operation not permitted E_NAMETOOLONG file name too long E_NOENT no such file or directory E_ISDIR is a directory E_ROFS read-only file system E_FAULT bad address E_LOOP too many symbolic links encountered E_IO on I/O errors E_BUSY device or resource busy E_INTR function call was interrupted E_LOOP too many symbolic links encountered E_MULTIHOP multihop attempted E_NOLINK link has been severed E_TXTBSY text file busy
const ::rtl::OUString & | ustrFileURL, |
sal_uInt64 | uAttributes ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | YES | YES | NO |
Set file attributes.
ustrFileURL | The full qualified file URL. |
uAttributes | Attributes of the file to be set. |
E_None on success E_INVAL the format of the parameters was not valid
const ::rtl::OUString & | ustrFileURL, |
const TimeValue & | rCreationTime, |
const TimeValue & | rLastAccessTime, |
const TimeValue & | rLastWriteTime ); |
virtual | abstract | const | volatile | template | static | inline | C-linkage |
NO | NO | NO | NO | NO | YES | YES | NO |
Set the file time.
ustrFileURL | The full qualified URL of the file. |
rCreationTime | Creation time of the given file. |
rLastAccessTime | Time of the last access of the given file. |
rLastWriteTime | Time of the last modifying of the given file. |
E_None on success E_INVAL the format of the parameters was not valid E_NOENT no such file or directory not found
Copyright © 2003 Sun Microsystems, Inc.