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

#include <store.hxx>

Classes

class  traveller
 Directory traversal helper. More...
 

Public Types

typedef storeFindData iterator
 Directory iterator type. More...
 

Public Member Functions

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

Member Typedef Documentation

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 ()
inlineexplicit

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: