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:

List of all members.

Public Member Functions
	LDAPException (int res_code, const std::string &err_string=std::string()) throw ()
	Constructs a LDAPException-object from the parameters.
	LDAPException (const LDAPAsynConnection *lc) throw ()
	Constructs a LDAPException-object from the error state of a LDAPAsynConnection-object.
virtual	~LDAPException () throw ()
	Destructor.
int	getResultCode () const throw ()
const std::string &	getResultMsg () const throw ()
const std::string &	getServerMsg () const throw ()
virtual const char *	what () const throw ()
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) throw ()
	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()
	)			throw ()

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

)

throw ()

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.

References m_err_string, m_res_code, and m_res_string.

LDAPException::~LDAPException

(

)

throw () [virtual]

Destructor.

---

Member Function Documentation

int LDAPException::getResultCode

(

)

const throw ()

Returns:

The Result code of the object

References m_res_code.

const string & LDAPException::getResultMsg

(

)

const throw ()

Returns:

The error message that is corresponding to the result code .

References m_res_string.

const string & LDAPException::getServerMsg

(

)

const throw ()

Returns:

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

References m_err_string.

const char * LDAPException::what

(

)

const throw () [virtual]

References m_res_string.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	s,
		LDAPException	e
	)			throw () [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]

Referenced by getServerMsg(), and LDAPException().

int LDAPException::m_res_code [private]

Referenced by getResultCode(), and LDAPException().

std::string LDAPException::m_res_string [private]

Referenced by getResultMsg(), LDAPException(), and what().

---

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

• LDAPException.h
• LDAPException.cpp