My Project
UDK 3.2.7 C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
store::OStoreFile Class Reference

#include <store.hxx>

Public Member Functions

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

Constructor & Destructor Documentation

store::OStoreFile::OStoreFile ( void  ) throw ()
inline

Construction.

store::OStoreFile::~OStoreFile ( void  ) throw ()
inline

Destruction.

store::OStoreFile::OStoreFile ( OStoreFile const &  rhs) throw ()
inline

Copy construction.

store::OStoreFile::OStoreFile ( storeFileHandle  Handle) throw ()
inlineexplicit

Construction from File Handle.

Member Function Documentation

storeError store::OStoreFile::attrib ( rtl::OUString const &  rPath,
rtl::OUString const &  rName,
sal_uInt32  nMask1,
sal_uInt32  nMask2,
sal_uInt32 &  rnAttrib 
) throw ()
inline

Set attributes of a file entry.

See Also
store_attrib()
storeError store::OStoreFile::attrib ( rtl::OUString const &  rPath,
rtl::OUString const &  rName,
sal_uInt32  nMask1,
sal_uInt32  nMask2 
) throw ()
inline

Set attributes of a file entry.

See Also
store_attrib()
void store::OStoreFile::close ( void  ) throw ()
inline

Close the file.

See Also
store_closeFile()
storeError store::OStoreFile::create ( rtl::OUString const &  rFilename,
storeAccessMode  eAccessMode,
sal_uInt16  nPageSize = STORE_DEFAULT_PAGESIZE 
) throw ()
inline

Open the file.

See Also
store_openFile()
storeError store::OStoreFile::createInMemory ( sal_uInt16  nPageSize = STORE_DEFAULT_PAGESIZE) throw ()
inline

Open the temporary file in memory.

See Also
store_createMemoryFile()
storeError store::OStoreFile::flush ( void  ) const throw ()
inline

Flush the file.

See Also
store_flushFile()
storeError store::OStoreFile::getRefererCount ( sal_uInt32 &  rnRefCount) const throw ()
inline

Get the number of referers to the file.

See Also
store_getFileRefererCount()
storeError store::OStoreFile::getSize ( sal_uInt32 &  rnSize) const throw ()
inline

Get the file size.

See Also
store_getFileSize()
bool store::OStoreFile::isValid ( void  ) const throw ()
inline

Check for a valid File Handle.

Returns
sal_True if valid, sal_False otherwise.
storeError store::OStoreFile::link ( rtl::OUString const &  rSrcPath,
rtl::OUString const &  rSrcName,
rtl::OUString const &  rDstPath,
rtl::OUString const &  rDstName 
) throw ()
inline

Insert a file entry as 'hard link' to another file entry.

See Also
store_link()
store::OStoreFile::operator storeFileHandle ( void  ) const throw ()
inline

Conversion into File Handle.

OStoreFile& store::OStoreFile::operator= ( OStoreFile const &  rhs) throw ()
inline

Assignment.

storeError store::OStoreFile::remove ( rtl::OUString const &  rPath,
rtl::OUString const &  rName 
) throw ()
inline

Remove a file entry.

See Also
store_remove()
storeError store::OStoreFile::rename ( rtl::OUString const &  rSrcPath,
rtl::OUString const &  rSrcName,
rtl::OUString const &  rDstPath,
rtl::OUString const &  rDstName 
) throw ()
inline

Rename a file entry.

See Also
store_rename()
storeError store::OStoreFile::symlink ( rtl::OUString const &  rSrcPath,
rtl::OUString const &  rSrcName,
rtl::OUString const &  rDstPath,
rtl::OUString const &  rDstName 
) throw ()
inline

Insert a file entry as 'symbolic link' to another file entry.

See Also
store_symlink()

The documentation for this class was generated from the following file: