---

FileSearch Class Reference
[recls.c++]

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

#include <filesearch.hpp>

Inheritance diagram for FileSearch:

List of all members.

Public Types
Types
typedef recls_char_t	char_type
typedef FileSearch	class_type
Public Methods
Construction
	FileSearch (char_type const *rootDir, char_type 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 ()
	Destructor.
Static Public Methods
Operations
FileEntry	Stat (char_type const *path, recls_uint32_t flags=RECLS_F_FILES|RECLS_F_DIRECTORIES|RECLS_F_DIRECTORY_PARTS)
	Retrieves the information for the given path.
Protected Methods
recls_rc_t &	GetLastError_ ()
Static Protected Methods
FileEntry	make_entry_ (recls_info_t info)

---

Detailed Description

This class provides functionality for executing a file search.

---

Member Typedef Documentation

typedef recls_char_t char_type

typedef FileSearch class_type

Reimplemented from Search.

typedef std::pair<hrecls_t, recls_rc_t> ctor_args_type [protected, inherited]

---

Constructor & Destructor Documentation

FileSearch (  char_type const *    rootDir, char_type 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]

Destructor.

---

Member Function Documentation

FileEntry GetCurrentEntry (    )  [inline, inherited]

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

recls_rc_t GetLastError (    )  [inline, inherited]

Returns the last error status code for this search object.

recls_rc_t & GetLastError_ (    )  [inline, protected, inherited]

recls_rc_t GetNext (    )  [inline, inherited]

Advances the search to the next position.

recls_uint32_t GetNumOutstandingDetails (    )  [inline, inherited]

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

recls_bool_t HasMoreElements (    )  [inline, inherited]

Returns non-zero if there is more data available.

FileEntry make_entry_ (  recls_info_t    info )  [inline, static, protected, inherited]

FileEntry Stat (  char_type const *    path, recls_uint32_t    flags = RECLS_F_FILES|RECLS_F_DIRECTORIES|RECLS_F_DIRECTORY_PARTS )  [inline, static]

Retrieves the information for the given path. Parameters: path  Absolute or relative path of the file system entry whose information is to be retrieved. flags  Flags to moderate the search. Only the type flags (flags & RECLS_F_TYPEMASK) and RECLS_F_DIRECTORY_PARTS are recognised Returns: A valid instance if the path/flags exists, or a 'null' instance. (A null instance e evaluates !e to be true).

---

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

• /include/recls/cpp/filesearch.hpp

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