---

FileSearch Class Reference
[recls.c++]

This class provides functionality for executing a file search. More...

#include <reclspp_filesearch.h>

List of all members.

Public Methods
Construction
	FileSearch (char const *rootDir, char const *pattern, recls_uint32_t flags)
	Creates a search for the items identified by pattern in the directory rootDir, according to the given flags.
	~FileSearch ()
	Closes the search and releases resources.
Operations
recls_rc_t	GetNext ()
	Advances the search to the next position.
Attributes
recls_bool_t	HasMoreElements () const
	Returns non-zero if there is more data available.
FileEntry	GetCurrentEntry () const
	Returns the current entry.
recls_rc_t	GetLastError () const
	Returns the last error status code for this search object.
recls_uint32_t	GetNumOutstandingDetails () const
	Returns the number of outstanding file-entry blocks associated with this search object.

---

Detailed Description

This class provides functionality for executing a file search.

---

Constructor & Destructor Documentation

FileSearch (  char const *    rootDir, char const *    pattern, recls_uint32_t    flags )  [inline]

Creates a search for the items identified by pattern in the directory rootDir, according to the given flags. Parameters: rootDir  The starting directory for the search. If NULL, or the empty string, uses the current directory pattern  The search pattern, e.g. "*.h". If NULL, or the empty string, uses "*.*" (Win32) or "*" (UNIX) flags  A combination of enumerants from the RECLS_FLAG enumeration

~FileSearch (    )  [inline]

Closes the search and releases resources.

---

Member Function Documentation

FileEntry GetCurrentEntry (    )  [inline]

Returns the current entry. Note: The behaviour is undefined when the HasMoreElements() returns zero

recls_rc_t GetLastError (    )  [inline]

Returns the last error status code for this search object.

recls_rc_t GetNext (    )  [inline]

Advances the search to the next position.

recls_uint32_t GetNumOutstandingDetails (    )  [inline]

Returns the number of outstanding file-entry blocks associated with this search object.

recls_bool_t HasMoreElements (    )  [inline]

Returns non-zero if there is more data available.

---

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

• /mappings/C++/reclspp_filesearch.h

recls Library documentation © Synesis Software Pty Ltd, 2001-2003