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

FtpSearch Class Reference
[recls.c++]

#include <recls/cpp/ftpsearch.hpp>

Inheritance diagram for FtpSearch:

Search List of all members.

Detailed Description

This class provides functionality for executing a file search.


Public Member Functions

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.


Constructor & Destructor Documentation

FtpSearch ( recls_char_t const *  host,
recls_char_t const *  username,
recls_char_t const *  password,
recls_char_t const *  rootDir,
recls_char_t 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:
host The host on which to search
username The username with which to gain access
password The password with which to gain access
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

~FtpSearch (  )  [inline]

Destructor.

FtpSearch ( recls_char_t const *  host,
recls_char_t const *  username,
recls_char_t const *  password,
recls_char_t const *  rootDir,
recls_char_t 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:
host The host on which to search
username The username with which to gain access
password The password with which to gain access
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

~FtpSearch (  )  [inline]

Destructor.


Member Function Documentation

recls_rc_t GetNext (  )  [inline, inherited]

Advances the search to the next position.

Examples:
example_cpp_1.cpp, and example_cpp_2.cpp.

recls_bool_t HasMoreElements (  )  const [inline, inherited]

Returns non-zero if there is more data available.

Examples:
example_cpp_1.cpp, and example_cpp_2.cpp.

FileEntry GetCurrentEntry (  )  const [inline, inherited]

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, inherited]

Returns the last error status code for this search object.

recls_uint32_t GetNumOutstandingDetails (  )  const [inline, inherited]

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


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

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