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

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

void freeLDAPControlArray (LDAPControl **ctrl)

Private Types

typedef CtrlList::const_iterator const_iterator

Private Attributes

CtrlList data


Detailed Description

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


Member Typedef Documentation

typedef CtrlList::const_iterator LDAPControlSet::const_iterator [private]
 


Constructor & Destructor Documentation

LDAPControlSet::LDAPControlSet  ) 
 

Constructs an empty std::list.

LDAPControlSet::LDAPControlSet const LDAPControlSet cs  ) 
 

Copy-constructor.

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

LDAPControlSet::~LDAPControlSet  ) 
 

Destructor.


Member Function Documentation

void LDAPControlSet::add const LDAPCtrl ctrl  ) 
 

Adds one element to the end of the list.

Parameters:
ctrl The Control to add to the list.

LDAPControlSet::const_iterator LDAPControlSet::begin  )  const
 

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

bool LDAPControlSet::empty  )  const
 

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

LDAPControlSet::const_iterator LDAPControlSet::end  )  const
 

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

void LDAPControlSet::freeLDAPControlArray LDAPControl **  ctrl  )  [static]
 

size_t LDAPControlSet::size  )  const
 

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

LDAPControl ** LDAPControlSet::toLDAPControlArray  )  const
 

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


Member Data Documentation

CtrlList LDAPControlSet::data [private]
 


The documentation for this class was generated from the following files:
Generated on Wed Jun 30 21:49:02 2004 for ldapsdk by doxygen 1.3.6