C/C++ User's Journal STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - where the Standard Template Library meets the Active Template Library COMSTL - where the Standard Template Library meets the Component Object Model
Synesis Software InetSTL - where the Standard Template Library meets the Internet UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

Search Class Reference
[recls.c++]

#include <recls/cpp/search.hpp>

Inheritance diagram for Search:

FileSearch FtpSearch List of all members.

Detailed Description

This class provides functionality for executing a file search.


Construction

virtual ~Search ()=0
 Closes the search and releases resources.
 Search (ctor_args_type args)
 Creates a search for the items identified by pattern in the directory rootDir, according to the given flags.


Constructor & Destructor Documentation

Search ( ctor_args_type  args  )  [inline, protected]

Creates a search for the items identified by pattern in the directory rootDir, according to the given flags.

Parameters:
args The arguments pair, containing the recls search handle and the error code associated with that handle

~Search (  )  [inline, pure virtual]

Closes the search and releases resources.

Note:
This is made pure-virtual just to make the class abstract. It imposes a tedious constraint on the inherited classes, but the alternative is risk this class being instantiated (if someone used the evil access #define trick).


Member Function Documentation

FileEntry GetCurrentEntry (  )  const [inline]

Returns the current entry.

Note:
The behaviour is undefined when the HasMoreElements() returns zero
Examples:
example_cpp_1.cpp, and example_cpp_2.cpp.

recls_rc_t GetLastError (  )  const [inline]

Returns the last error status code for this search object.

recls_rc_t GetNext (  )  [inline]

Advances the search to the next position.

Examples:
example_cpp_1.cpp, and example_cpp_2.cpp.

recls_uint32_t GetNumOutstandingDetails (  )  const [inline]

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

recls_bool_t HasMoreElements (  )  const [inline]

Returns non-zero if there is more data available.

Examples:
example_cpp_1.cpp, and example_cpp_2.cpp.


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

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