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

LDAPCtrl Class Reference

This class is used to store Controls. More...

#include <LDAPControl.h>

List of all members.

Public Member Functions

 LDAPCtrl (const LDAPCtrl &c)
 Copy-constructor.
 LDAPCtrl (const char *oid, bool critical, const char *data=0, int length=0)
 Constructor.
 LDAPCtrl (const std::string &oid, bool critical=false, const std::string &data=std::string())
 Constructor.
 LDAPCtrl (const LDAPControl *ctrl)
 Creates a copy of the Control that "ctrl is pointing to.
 ~LDAPCtrl ()
 Destructor.
std::string getOID () const
std::string getData () const
bool isCritical () const
LDAPControl * getControlStruct () const
 For internal use only.

Static Public Member Functions

void freeLDAPControlStruct (LDAPControl *ctrl)

Private Attributes

std::string m_oid
std::string m_data
bool m_isCritical


Detailed Description

This class is used to store Controls.

Controls are a mechanism to extend and modify LDAP-Operations.


Constructor & Destructor Documentation

LDAPCtrl::LDAPCtrl const LDAPCtrl c  ) 
 

Copy-constructor.

LDAPCtrl::LDAPCtrl const char *  oid,
bool  critical,
const char *  data = 0,
int  length = 0
 

Constructor.

Parameters:
oid: The Object Identifier of the Control
critical: "true" if the Control should be handled critical by the server.
data: If there is data for the control, put it here.
length: The length of the data field

LDAPCtrl::LDAPCtrl const std::string &  oid,
bool  critical = false,
const std::string &  data = std::string()
 

Constructor.

Parameters:
oid: The Object Identifier of the Control
critical: "true" if the Control should be handled critical by the server.
data: If there is data for the control, put it here.

LDAPCtrl::LDAPCtrl const LDAPControl *  ctrl  ) 
 

Creates a copy of the Control that "ctrl is pointing to.

LDAPCtrl::~LDAPCtrl  ) 
 

Destructor.


Member Function Documentation

void LDAPCtrl::freeLDAPControlStruct LDAPControl *  ctrl  )  [static]
 

LDAPControl * LDAPCtrl::getControlStruct  )  const
 

For internal use only.

Translates the control to a LDAPControl-structure as needed by the C-API

string LDAPCtrl::getData  )  const
 

Returns:
The Data of the control as a std::string-Objekt

string LDAPCtrl::getOID  )  const
 

Returns:
The OID of the control

bool LDAPCtrl::isCritical  )  const
 

Returns:
"true" if the control is critical


Member Data Documentation

std::string LDAPCtrl::m_data [private]
 

bool LDAPCtrl::m_isCritical [private]
 

std::string LDAPCtrl::m_oid [private]
 


The documentation for this class was generated from the following files:
Generated on Wed Nov 12 02:19:04 2008 for ldapsdk by  doxygen 1.3.9.1