---

FtpSearch Class Reference
[recls.c++]

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

#include <ftpsearch.hpp>

Inheritance diagram for FtpSearch:

List of all members.

Public Types
Types
typedef FtpSearch	class_type
Public Methods
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.
Construction
	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)
	Creates a search for the items identified by pattern in the directory rootDir, according to the given flags.
	~FtpSearch ()
	Destructor.
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.
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.
Protected Types
Construction
typedef std::pair< hrecls_t, recls_rc_t >	ctor_args_type
Construction
typedef std::pair< hrecls_t, recls_rc_t >	ctor_args_type
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 FtpSearch class_type

Reimplemented from Search.

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

---

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.

---

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]

---

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

• /include/recls/cpp/ftpsearch.hpp

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