Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

LDAPForwardIterator Class Reference

A forward iterator for LDAP Objects. More...

List of all members.

Public Member Functions

 LDAPForwardIterator (generic_search_result_t *results)
 Constructor.

generic_result_entry_tfirst ()
 Rewinds the LDAP forward iterator and returns the first entry.

generic_result_entry_tnext ()
 Moves the iterator to next result entry.

generic_result_entry_tcurrent () const
 Gets the current result entry.

std::string ldap_dn ()
 DN extractor.

const LDIFObjectoperator * ()
 LDIFObject extractor.

LDIFObjectoperator-> ()
 ~LDAPForwardIterator ()
 Destructor.


Detailed Description

A forward iterator for LDAP Objects.

It applies to LDAP Query results a powerful means of reading.

Author:
Salvatore Monforte salvatore.monforte@ct.infn.it


Constructor & Destructor Documentation

LDAPForwardIterator generic_search_result_t results  ) 
 

Constructor.

Parameters:
results pointer to LDAP result to iterate.

~LDAPForwardIterator  ) 
 

Destructor.


Member Function Documentation

generic_result_entry_t* current  )  const
 

Gets the current result entry.

Returns:
a pointer to the current result entry the iterator points to.

generic_result_entry_t* first  ) 
 

Rewinds the LDAP forward iterator and returns the first entry.

After use of this method, the forward iterator is addressed to the first query result record.

Returns:
a pointer to the first result entry, NULL is no entry is available.

std::string ldap_dn  ) 
 

DN extractor.

Returns:
the distinguished name of the result entry the iterator points to.

generic_result_entry_t* next  ) 
 

Moves the iterator to next result entry.

Returns:
a pointer to the next result entry, or NULL if no further entry is available.

const LDIFObject& operator *  ) 
 

LDIFObject extractor.

Returns:
a reference to the LDIFObject the iterator points to.

LDIFObject* operator->  ) 
 


The documentation for this class was generated from the following file:
Generated on Wed Mar 1 00:37:56 2006 for COMMON API - configuration, jobid, ldif2classadi, logger, process, requestad, socket++i, task, utilities by doxygen 1.3.5