store::OStoreFile Class Reference

#include <store.hxx>

Public Member Functions
	OStoreFile ()
	~OStoreFile ()
	OStoreFile (OStoreFile const &rhs)
OStoreFile &	operator= (OStoreFile const &rhs)
	operator storeFileHandle () const
bool	isValid () const
	Check for a valid File Handle. More...
storeError	create (OUString const &rFilename, storeAccessMode eAccessMode)
	Open the file. More...
storeError	createInMemory ()
	Open the temporary file in memory. More...
void	close ()
	Close the file. More...
storeError	flush () const
	Flush the file. More...
storeError	remove (OUString const &rPath, OUString const &rName)
	Remove a file entry. More...

Private Attributes
storeFileHandle	m_hImpl

Detailed Description

Definition at line 205 of file store.hxx.

Constructor & Destructor Documentation

OStoreFile() [1/2]

store::OStoreFile::OStoreFile ( )

inline

Definition at line 208 of file store.hxx.

~OStoreFile()

store::OStoreFile::~OStoreFile ( )

inline

Definition at line 212 of file store.hxx.

References m_hImpl, and store_releaseHandle().

OStoreFile() [2/2]

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

inline

Definition at line 218 of file store.hxx.

References m_hImpl, and store_acquireHandle().

Member Function Documentation

close()

void store::OStoreFile::close ( )

inline

Close the file.

See also

store_closeFile()

Definition at line 279 of file store.hxx.

References m_hImpl, and store_closeFile().

create()

storeError store::OStoreFile::create ( OUString const &  rFilename, storeAccessMode  eAccessMode  )

inline

Open the file.

See also

store_openFile()

Definition at line 251 of file store.hxx.

References m_hImpl, STORE_DEFAULT_PAGESIZE, store_openFile(), and store_releaseHandle().

createInMemory()

storeError store::OStoreFile::createInMemory ( )

inline

Open the temporary file in memory.

See also

store_createMemoryFile()

Definition at line 266 of file store.hxx.

References m_hImpl, store_createMemoryFile(), STORE_DEFAULT_PAGESIZE, and store_releaseHandle().

flush()

storeError store::OStoreFile::flush ( ) const

inline

Flush the file.

See also

store_flushFile()

Definition at line 291 of file store.hxx.

References m_hImpl, store_E_InvalidHandle, and store_flushFile().

isValid()

bool store::OStoreFile::isValid ( ) const

inline

Check for a valid File Handle.

Returns

sal_True if valid, sal_False otherwise.

Definition at line 243 of file store.hxx.

References m_hImpl.

operator storeFileHandle()

store::OStoreFile::operator storeFileHandle ( ) const

inline

Definition at line 235 of file store.hxx.

References m_hImpl.

operator=()

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

inline

Definition at line 225 of file store.hxx.

References m_hImpl, store_acquireHandle(), and store_releaseHandle().

remove()

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

inline

Remove a file entry.

See also

store_remove()

Definition at line 302 of file store.hxx.

References m_hImpl, store_E_InvalidHandle, and store_remove().

Member Data Documentation

m_hImpl

storeFileHandle store::OStoreFile::m_hImpl

private

Definition at line 312 of file store.hxx.

Referenced by close(), create(), createInMemory(), flush(), isValid(), operator storeFileHandle(), operator=(), OStoreFile(), remove(), and ~OStoreFile().

---

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

• store.hxx