Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

 Overview   Namespace   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 ::

class File

Base Classes
FileBase (public)
  |  
  +--File
Known Derived Classes
None.

virtual abstract interface template
NO NO NO NO
Summary
The file class object provides access to file contents and attributes.
See Also
Directory
DirectoryItem
File
file.hxx

Public Members

Methods

File( const ::rtl::OUString & ustrFileURL );		 Constructor.

~File( );		 Destructor
RC
open( sal_uInt32 uFlags );		 Open a regular file.
RC
close( );		 Close an open file.
RC
setPos( sal_uInt32 uHow, sal_Int64 uPos );		 Set the internal position pointer of an open file.
RC
getPos( sal_uInt64 & uPos );		 Retrieve the current position of the internal pointer of an open file.
RC
isEndOfFile( sal_Bool * pIsEOF );		 Test if the end of a file is reached.
RC
setSize( sal_uInt64 uSize );		 Set the file size of an open file.
RC
getSize( sal_uInt64 & rSize );		 Get the file size of an open file.
RC
read( void * pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 & rBytesRead );		 Read a number of bytes from a file.
RC
write( const void * pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 & rBytesWritten );		 Write a number of bytes to a file.
RC
readLine( ::rtl::ByteSequence & aSeq );		 Read a line from a file.
RC
sync( ) const;		 Synchronize the memory representation of a file with that on the physical medium.

Static Methods
static RC
copy( const ::rtl::OUString & ustrSourceFileURL, const ::rtl::OUString & ustrDestFileURL );		 Copy a file to a new destination.
static RC
move( const ::rtl::OUString & ustrSourceFileURL, const ::rtl::OUString & ustrDestFileURL );		 Move a file or directory to a new destination or renames it.
static RC
remove( const ::rtl::OUString & ustrFileURL );		 Remove a regular file.
static RC
setAttributes( const ::rtl::OUString & ustrFileURL, sal_uInt64 uAttributes );		 Set file attributes.
static RC
setTime( const ::rtl::OUString & ustrFileURL, const TimeValue & rCreationTime, const TimeValue & rLastAccessTime, const TimeValue & rLastWriteTime );		 Set the file time.

Private Members

Methods

File( File & );		 Copy constructor.
File &
operator=( File & );		 Assginment operator.

Data
oslFileHandle _pData;
::rtl::OUString _aPath;
Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.