class File

Class

Index

Help

PUBLIC MEMBERS:	CLASSES \| STRUCTS \| UNIONS \| ENUMS \| TYPEDEFS \| METHODS \| STATIC METHODS \| DATA \| STATIC DATA
PRIVATE MEMBERS:	CLASSES \| STRUCTS \| UNIONS \| ENUMS \| TYPEDEFS \| METHODS \| STATIC METHODS \| DATA \| STATIC DATA

:: osl ::

Base Classes

FileBase (public)
  |  
  +--File

virtual	abstract	interface	template
NO	NO	NO	NO

Summary

The file class object provides access to file contents and attributes

See Also

Directory
DirectoryItem

Methods
File( const ::rtl::OUString & strPath );	C'tor
~File( );	D'tor
RC close( );	Closes an open file.
RC setPos( sal_uInt32 uHow, sal_Int64 uPos );	Sets the internal position pointer of an open file.
RC getPos( sal_uInt64 & uPos );	Retrieves the current position of the internal pointer of an open file.
RC isEndOfFile( sal_Bool * pIsEOF );	Tests if the end of a file is reached.
RC setSize( sal_uInt64 uSize );	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.
RC read( void * pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 & rBytesRead );	Reads a number of bytes from a file. The internal file pointer is increased by the number of bytes read.
RC write( const void * pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 & rBytesWritten );	Writes a number of bytes to a file. The internal file pointer is increased by the number of bytes read.
RC readLine( ::rtl::ByteSequence & aSeq );	Reads a line from given file. The new line delemeter(s) are NOT returned!

Static Methods
static RC copy( const ::rtl::OUString & strPath, const ::rtl::OUString & strDestPath );	Copies a file to a new destination. Copies only files not directories. No assumptions should be made about preserving attributes or file time.
static RC move( const ::rtl::OUString & strPath, const ::rtl::OUString & strDestPath );	Moves a file or directory to a new destination or renames it. File time and attributes are preserved.
static RC remove( const ::rtl::OUString & strPath );	Removes (erases) a regular file.
static RC setAttributes( const ::rtl::OUString & strPath, sal_uInt64 uAttributes );	Sets file-attributes
static RC setTime( const ::rtl::OUString & strPath, TimeValue & rCreationTime, TimeValue & rLastAccessTime, TimeValue & rLastWriteTime );	Sets file-Time

Methods
File( File & );	define copy c'tor and assginment operator privat
File & operator=( File & );