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

LDAPException Class Reference

This class is only thrown as an Exception and used to signalize error conditions during LDAP-operations. More...

#include <LDAPException.h>

Inheritance diagram for LDAPException:

LDAPReferralException List of all members.

Public Member Functions

 LDAPException (int res_code, const std::string &err_string=std::string())
 Constructs a LDAPException-object from the parameters.

 LDAPException (const LDAPAsynConnection *lc)
 Constructs a LDAPException-object from the error state of a LDAPAsynConnection-object.

virtual ~LDAPException ()
 Destructor.

int getResultCode () const
const std::string & getResultMsg () const
const std::string & getServerMsg () const

Private Attributes

int m_res_code
std::string m_res_string
std::string m_err_string

Friends

std::ostream & operator<< (std::ostream &s, LDAPException e)
 This method can be used to dump the data of a LDAPResult-Object.


Detailed Description

This class is only thrown as an Exception and used to signalize error conditions during LDAP-operations.


Constructor & Destructor Documentation

LDAPException::LDAPException int  res_code,
const std::string &  err_string = std::string()
 

Constructs a LDAPException-object from the parameters.

Parameters:
res_code A valid LDAP result code.
err_string An addional error message for the error that happend (optional)

LDAPException::LDAPException const LDAPAsynConnection lc  ) 
 

Constructs a LDAPException-object from the error state of a LDAPAsynConnection-object.

Parameters:
lc A LDAP-Connection for that an error has happend. The Constructor tries to read its error state.

LDAPException::~LDAPException  )  [virtual]
 

Destructor.


Member Function Documentation

int LDAPException::getResultCode  )  const
 

Returns:
The Result code of the object

const string & LDAPException::getResultMsg  )  const
 

Returns:
The error message that is corresponding to the result code .

const string & LDAPException::getServerMsg  )  const
 

Returns:
The addional error message of the error (if it was set)


Friends And Related Function Documentation

std::ostream& operator<< std::ostream &  s,
LDAPException  e
[friend]
 

This method can be used to dump the data of a LDAPResult-Object.

It is only useful for debugging purposes at the moment


Member Data Documentation

std::string LDAPException::m_err_string [private]
 

int LDAPException::m_res_code [private]
 

std::string LDAPException::m_res_string [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