store::OStoreDirectory Class Reference

#include <store.hxx>

List of all members.

Classes
class	traveller
	Directory traversal helper. More...
Public Types
typedef storeFindData	iterator
	Directory iterator type.
Public Member Functions
	OStoreDirectory (void) throw ()
	Construction.
	~OStoreDirectory (void) throw ()
	Destruction.
	OStoreDirectory (OStoreDirectory const &rhs) throw ()
	Copy construction.
OStoreDirectory &	operator= (OStoreDirectory const &rhs) throw ()
	Assignment.
	OStoreDirectory (storeDirectoryHandle Handle) throw ()
	Construction from Directory Handle.
	operator storeDirectoryHandle (void) const throw ()
	Conversion into Directory Handle.
bool	isValid (void) const throw ()
	Check for a valid Directory Handle.
storeError	create (storeFileHandle hFile, rtl::OUString const &rPath, rtl::OUString const &rName, storeAccessMode eMode) throw ()
	Open the directory.
void	close (void) throw ()
	Close the directory.
storeError	first (iterator &it) throw ()
	Find first directory entry.
storeError	next (iterator &it) throw ()
	Find next directory entry.
storeError	travel (traveller &rTraveller) const
	Directory traversal.

---

Member Typedef Documentation

typedef storeFindData store::OStoreDirectory::iterator

Directory iterator type.

See also:

first()

next()

---

Constructor & Destructor Documentation

store::OStoreDirectory::OStoreDirectory

(

void

)

throw () [inline]

Construction.

store::OStoreDirectory::~OStoreDirectory

(

void

)

throw () [inline]

Destruction.

store::OStoreDirectory::OStoreDirectory

(

OStoreDirectory const &

rhs

)

throw () [inline]

Copy construction.

store::OStoreDirectory::OStoreDirectory

(

storeDirectoryHandle

Handle

)

throw () [inline, explicit]

Construction from Directory Handle.

---

Member Function Documentation

void store::OStoreDirectory::close

(

void

)

throw () [inline]

Close the directory.

See also:

store_closeDirectory()

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

Open the directory.

See also:

store_openDirectory()

storeError store::OStoreDirectory::first

(

iterator &

it

)

throw () [inline]

Find first directory entry.

See also:

store_findFirst()

bool store::OStoreDirectory::isValid

(

void

)

const throw () [inline]

Check for a valid Directory Handle.

Returns:

sal_True if valid, sal_False otherwise.

storeError store::OStoreDirectory::next

(

iterator &

it

)

throw () [inline]

Find next directory entry.

See also:

store_findNext()

store::OStoreDirectory::operator storeDirectoryHandle

(

void

)

const throw () [inline]

Conversion into Directory Handle.

OStoreDirectory& store::OStoreDirectory::operator=

(

OStoreDirectory const &

rhs

)

throw () [inline]

Assignment.

storeError store::OStoreDirectory::travel

(

traveller &

rTraveller

)

const [inline]

Directory traversal.

See also:

store_findFirst()

store_findNext()

Parameters:

rTraveller

[in] the traversal callback.

Returns:

store_E_NoMoreFiles upon end of iteration.

---

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

• store/store.hxx