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

Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Search Class Reference
[recls.c++]

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

#include <search.hpp>

Inheritance diagram for Search:

FileSearch FtpSearch List of all members.

Construction

virtual ~Search ()=0
 Closes the search and releases resources.

typedef std::pair< hrecls_t,
recls_rc_t
ctor_args_type
 Search (ctor_args_type args)
 Creates a search for the items identified by pattern in the directory rootDir, according to the given flags.


Public Types

Types
typedef Search class_type

Protected Methods

recls_rc_tGetLastError_ ()

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 Search class_type
 

Reimplemented in FileSearch, and FtpSearch.

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


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   [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 & GetLastError_   [inline, protected]
 

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.

FileEntry make_entry_ recls_info_t    info [inline, static, protected]
 


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

recls Library documentation Synesis Software Pty Ltd, 2001-2005