store::OStoreStream Class Reference

#include <store.hxx>

List of all members.

Public Member Functions
	OStoreStream (void) throw ()
	Construction.
	~OStoreStream (void) throw ()
	Destruction.
	OStoreStream (OStoreStream const &rhs) throw ()
	Copy construction.
OStoreStream &	operator= (OStoreStream const &rhs) throw ()
	Assignment.
	OStoreStream (storeStreamHandle Handle) throw ()
	Construction from Stream Handle.
	operator storeStreamHandle (void) const throw ()
	Conversion into Stream Handle.
bool	isValid (void) const throw ()
	Check for a valid Stream Handle.
storeError	create (storeFileHandle hFile, rtl::OUString const &rPath, rtl::OUString const &rName, storeAccessMode eMode) throw ()
	Open the stream.
void	close (void) throw ()
	Close the stream.
storeError	readAt (sal_uInt32 nOffset, void *pBuffer, sal_uInt32 nBytes, sal_uInt32 &rnDone) throw ()
	Read from the stream.
storeError	writeAt (sal_uInt32 nOffset, void const *pBuffer, sal_uInt32 nBytes, sal_uInt32 &rnDone) throw ()
	Write to the stream.
storeError	flush (void) const throw ()
	Flush the stream.
storeError	getSize (sal_uInt32 &rnSize) const throw ()
	Get the stream size.
storeError	setSize (sal_uInt32 nSize) throw ()
	Set the stream size.

---

Constructor & Destructor Documentation

store::OStoreStream::OStoreStream

(

void

)

throw () [inline]

Construction.

store::OStoreStream::~OStoreStream

(

void

)

throw () [inline]

Destruction.

store::OStoreStream::OStoreStream

(

OStoreStream const &

rhs

)

throw () [inline]

Copy construction.

store::OStoreStream::OStoreStream

(

storeStreamHandle

Handle

)

throw () [inline, explicit]

Construction from Stream Handle.

---

Member Function Documentation

void store::OStoreStream::close

(

void

)

throw () [inline]

Close the stream.

See also:

store_closeStream()

storeError store::OStoreStream::create	(	storeFileHandle	hFile,
		rtl::OUString const &	rPath,
		rtl::OUString const &	rName,
		storeAccessMode	eMode
	)			throw () [inline]

Open the stream.

See also:

store_openStream()

storeError store::OStoreStream::flush

(

void

)

const throw () [inline]

Flush the stream.

See also:

store_flushStream()

storeError store::OStoreStream::getSize

(

sal_uInt32 &

rnSize

)

const throw () [inline]

Get the stream size.

See also:

store_getStreamSize()

bool store::OStoreStream::isValid

(

void

)

const throw () [inline]

Check for a valid Stream Handle.

Returns:

sal_True if valid, sal_False otherwise.

store::OStoreStream::operator storeStreamHandle

(

void

)

const throw () [inline]

Conversion into Stream Handle.

OStoreStream& store::OStoreStream::operator=

(

OStoreStream const &

rhs

)

throw () [inline]

Assignment.

storeError store::OStoreStream::readAt	(	sal_uInt32	nOffset,
		void *	pBuffer,
		sal_uInt32	nBytes,
		sal_uInt32 &	rnDone
	)			throw () [inline]

Read from the stream.

See also:

store_readStream()

storeError store::OStoreStream::setSize

(

sal_uInt32

nSize

)

throw () [inline]

Set the stream size.

See also:

store_setStreamSize()

storeError store::OStoreStream::writeAt	(	sal_uInt32	nOffset,
		void const *	pBuffer,
		sal_uInt32	nBytes,
		sal_uInt32 &	rnDone
	)			throw () [inline]

Write to the stream.

See also:

store_writeStream()

---

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

• store/store.hxx