Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: store ::

class OStoreFile


Base Classes
None.
Known Derived Classes
None.

virtual abstract interface template
NO NO NO NO
File
store.hxx

Public Members

Methods


OStoreFile( void ) throw( );
Construction.

~OStoreFile( void ) throw( );
Destruction.

OStoreFile( const OStoreFile & rhs ) throw( );
Copy construction.
OStoreFile &
operator=( const OStoreFile & rhs ) throw( );
Assignment.
explicit
OStoreFile( storeFileHandle Handle ) throw( );
Construction from File Handle.

operator storeFileHandle( void ) const throw( );
Conversion into File Handle.
bool
isValid( void ) const throw( );
Check for a valid File Handle.
storeError
create( const rtl::OUString & rFilename, storeAccessMode eAccessMode, sal_uInt16 nPageSize = STORE_DEFAULT_PAGESIZE ) throw( );
Open the file.
storeError
createInMemory( sal_uInt16 nPageSize = STORE_DEFAULT_PAGESIZE ) throw( );
Open the temporary file in memory.
void
close( void ) throw( );
Close the file.
storeError
flush( void ) const throw( );
Flush the file.
storeError
getRefererCount( sal_uInt32 & rnRefCount ) const throw( );
Get the number of referers to the file.
storeError
getSize( sal_uInt32 & rnSize ) const throw( );
Get the file size.
storeError
attrib( const rtl::OUString & rPath, const rtl::OUString & rName, sal_uInt32 nMask1, sal_uInt32 nMask2, sal_uInt32 & rnAttrib ) throw( );
Set attributes of a file entry.
storeError
attrib( const rtl::OUString & rPath, const rtl::OUString & rName, sal_uInt32 nMask1, sal_uInt32 nMask2 ) throw( );
Set attributes of a file entry.
storeError
link( const rtl::OUString & rSrcPath, const rtl::OUString & rSrcName, const rtl::OUString & rDstPath, const rtl::OUString & rDstName ) throw( );
Insert a file entry as 'hard link' to another file entry.
storeError
symlink( const rtl::OUString & rSrcPath, const rtl::OUString & rSrcName, const rtl::OUString & rDstPath, const rtl::OUString & rDstName ) throw( );
Insert a file entry as 'symbolic link' to another file entry.
storeError
rename( const rtl::OUString & rSrcPath, const rtl::OUString & rSrcName, const rtl::OUString & rDstPath, const rtl::OUString & rDstName ) throw( );
Rename a file entry.
storeError
remove( const rtl::OUString & rPath, const rtl::OUString & rName ) throw( );
Remove a file entry.

Private Members

Data

storeFileHandle m_hImpl; Representation.

Top of Page

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.