ldapsdk  0.0.1
Public Member Functions | List of all members
LDAPSearchResults Class Reference

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

#include <LDAPSearchResults.h>

Public Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

◆ LDAPSearchResults()

LDAPSearchResults::LDAPSearchResults ( )

Default-Constructor.

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

Member Function Documentation

◆ getNext()

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
LDAPReferralExceptionIf 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 LDAPEntryList::end(), and LDAPReferenceList::end().

◆ readMessageQueue()

LDAPResult * LDAPSearchResults::readMessageQueue ( LDAPMessageQueue msg)

For internal use only.

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

Parameters
msgThe message queue to read

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

Referenced by LDAPConnection::search().


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