LDAPSearchResults Class Reference

The class stores the results of a synchronous SEARCH-Operation. More...

#include <LDAPSearchResults.h>

List of all members.

Public Member Functions

 LDAPSearchResults ()
 Default-Constructor.
LDAPResultreadMessageQueue (LDAPMessageQueue *msg)
 For internal use only.
LDAPEntrygetNext ()
 The method is used by the client-application to read the result entries of the SEARCH-Operation.

Detailed Description

The class stores the results of a synchronous SEARCH-Operation.


Constructor & Destructor Documentation

LDAPSearchResults::LDAPSearchResults (  ) 

Default-Constructor.

References LDAPReferenceList::begin(), and LDAPEntryList::begin().


Member Function Documentation

LDAPEntry * LDAPSearchResults::getNext (  ) 

The method is used by the client-application to read the result entries of the SEARCH-Operation.

Every call of this method returns one entry. If all entries were read it return 0.

Exceptions:
LDAPReferralException If a Search Reference was returned by the server
Returns:
A LDAPEntry-object as a result of a SEARCH-Operation or 0 if no more entries are there to return.

References LDAPReferenceList::end(), and LDAPEntryList::end().

LDAPResult * LDAPSearchResults::readMessageQueue ( LDAPMessageQueue msg  ) 

For internal use only.

This method reads Search result entries from a LDAPMessageQueue-object.

Parameters:
msg The message queue to read

References LDAPEntryList::addEntry(), LDAPReferenceList::addReference(), LDAPReferenceList::begin(), LDAPEntryList::begin(), LDAPMsg::getMessageType(), LDAPMessageQueue::getNext(), LDAPMsg::SEARCH_ENTRY, and LDAPMsg::SEARCH_REFERENCE.


The documentation for this class was generated from the following files:
Generated on Mon Jul 5 13:35:54 2010 for ldapsdk by  doxygen 1.6.3