LDAPControlSet Class Reference

This container class is used to store multiple LDAPCtrl-objects. More...

#include <LDAPControlSet.h>

List of all members.

Public Member Functions
	LDAPControlSet ()
	Constructs an empty std::list.
	LDAPControlSet (const LDAPControlSet &cs)
	Copy-constructor.
	LDAPControlSet (LDAPControl **controls)
	For internal use only.
	~LDAPControlSet ()
	Destructor.
size_t	size () const
bool	empty () const
const_iterator	begin () const
const_iterator	end () const
void	add (const LDAPCtrl &ctrl)
	Adds one element to the end of the list.
LDAPControl **	toLDAPControlArray () const
	Translates the list to a 0-terminated array of pointers to LDAPControl-structures as needed by the C-API.
Static Public Member Functions
static void	freeLDAPControlArray (LDAPControl **ctrl)

---

Detailed Description

This container class is used to store multiple LDAPCtrl-objects.

---

Constructor & Destructor Documentation

LDAPControlSet::LDAPControlSet

(

)

Constructs an empty std::list.

LDAPControlSet::LDAPControlSet

(

const LDAPControlSet &

cs

)

Copy-constructor.

References data, DEBUG, and LDAP_DEBUG_CONSTRUCT.

LDAPControlSet::LDAPControlSet

(

LDAPControl **

controls

)

For internal use only.

This constructor creates a new LDAPControlSet for a 0-terminiated array of LDAPControl-structures as used by the C-API

Parameters:

controls,:

pointer to a 0-terminated array of pointers to LDAPControll-structures

Note:

: untested til now. Due to lack of server that return Controls

References DEBUG, and LDAP_DEBUG_CONSTRUCT.

LDAPControlSet::~LDAPControlSet

(

)

Destructor.

References DEBUG, and LDAP_DEBUG_DESTROY.

---

Member Function Documentation

size_t LDAPControlSet::size

(

)

const

Returns:

The number of LDAPCtrl-objects that are currently stored in this list.

References DEBUG, and LDAP_DEBUG_TRACE.

bool LDAPControlSet::empty

(

)

const

Returns:

true if there are zero LDAPCtrl-objects currently stored in this list.

References DEBUG, and LDAP_DEBUG_TRACE.

LDAPControlSet::const_iterator LDAPControlSet::begin

(

)

const

Returns:

A iterator that points to the first element of the list.

References DEBUG, and LDAP_DEBUG_TRACE.

LDAPControlSet::const_iterator LDAPControlSet::end

(

)

const

Returns:

A iterator that points to the element after the last element of the list.

References DEBUG, and LDAP_DEBUG_TRACE.

void LDAPControlSet::add

(

const LDAPCtrl &

ctrl

)

Adds one element to the end of the list.

Parameters:

ctrl

The Control to add to the list.

References DEBUG, and LDAP_DEBUG_TRACE.

LDAPControl ** LDAPControlSet::toLDAPControlArray

(

)

const

Translates the list to a 0-terminated array of pointers to LDAPControl-structures as needed by the C-API.

References DEBUG, and LDAP_DEBUG_TRACE.

Referenced by LDAPConstraints::getClCtrlsArray(), and LDAPConstraints::getSrvCtrlsArray().

void LDAPControlSet::freeLDAPControlArray

(

LDAPControl **

ctrl

)

[static]

References DEBUG, LDAPCtrl::freeLDAPControlStruct(), and LDAP_DEBUG_TRACE.

Referenced by LDAPSearchRequest::sendRequest(), LDAPModifyRequest::sendRequest(), LDAPModDNRequest::sendRequest(), LDAPExtRequest::sendRequest(), LDAPDeleteRequest::sendRequest(), LDAPCompareRequest::sendRequest(), LDAPSaslBindRequest::sendRequest(), LDAPBindRequest::sendRequest(), LDAPAddRequest::sendRequest(), and LDAPAsynConnection::unbind().

---

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

• LDAPControlSet.h
• LDAPControlSet.cpp