KLDAP Library
KLDAP::LdapControl Class Reference
This class represents an LDAP Control. More...
#include <ldapcontrol.h>
Public Member Functions | |
LdapControl (const LdapControl &that) | |
LdapControl (QString &oid, QByteArray &value, bool critical=false) | |
LdapControl () | |
virtual | ~LdapControl () |
bool | critical () const |
QString | oid () const |
LdapControl & | operator= (const LdapControl &that) |
int | parsePageControl (QByteArray &cookie) const |
void | setControl (const QString &oid, const QByteArray &value, bool critical=false) |
void | setCritical (bool critical) |
void | setOid (const QString &oid) |
void | setValue (const QByteArray &value) |
QByteArray | value () const |
Static Public Member Functions | |
static LdapControl | createPageControl (int pagesize, const QByteArray &cookie=QByteArray()) |
static void | insert (LdapControls &list, const LdapControl &ctrl) |
Detailed Description
This class represents an LDAP Control.
Definition at line 39 of file ldapcontrol.h.
Constructor & Destructor Documentation
LdapControl::LdapControl | ( | ) |
Creates an empty control.
Definition at line 48 of file ldapcontrol.cpp.
LdapControl::LdapControl | ( | QString & | oid, | |
QByteArray & | value, | |||
bool | critical = false | |||
) |
Creates a control with the given OID, value and criticality.
Definition at line 54 of file ldapcontrol.cpp.
LdapControl::~LdapControl | ( | ) | [virtual] |
Destroys the control object.
Definition at line 77 of file ldapcontrol.cpp.
Member Function Documentation
LdapControl LdapControl::createPageControl | ( | int | pagesize, | |
const QByteArray & | cookie = QByteArray() | |||
) | [static] |
Creates a paging search control.
Definition at line 133 of file ldapcontrol.cpp.
bool LdapControl::critical | ( | ) | const |
Returns the control's criticality.
Definition at line 98 of file ldapcontrol.cpp.
void LdapControl::insert | ( | LdapControls & | list, | |
const LdapControl & | ctrl | |||
) | [static] |
Inserts a unique control against a list of controls.
If the control already exists in the list is is updated, otherwise it is appended to the list.
- Since:
- 4.4
Definition at line 144 of file ldapcontrol.cpp.
QString LdapControl::oid | ( | ) | const |
Returns the control's OID.
Definition at line 88 of file ldapcontrol.cpp.
int LdapControl::parsePageControl | ( | QByteArray & | cookie | ) | const |
Parses a paging results control, which the server returned.
Puts the server's cookie into cookie
, and returns the estimated result set size. If the OID is not the page control's OID, or the value cannot be decoded, returns -1.
Definition at line 118 of file ldapcontrol.cpp.
void LdapControl::setControl | ( | const QString & | oid, | |
const QByteArray & | value, | |||
bool | critical = false | |||
) |
Sets the control's OID, value and criticality.
Definition at line 81 of file ldapcontrol.cpp.
void LdapControl::setCritical | ( | bool | critical | ) |
Sets the control's criticality.
Definition at line 113 of file ldapcontrol.cpp.
void LdapControl::setOid | ( | const QString & | oid | ) |
Sets the control's OID.
Definition at line 103 of file ldapcontrol.cpp.
void LdapControl::setValue | ( | const QByteArray & | value | ) |
Sets the control's value.
Definition at line 108 of file ldapcontrol.cpp.
QByteArray LdapControl::value | ( | ) | const |
Returns the control's value.
Definition at line 93 of file ldapcontrol.cpp.
The documentation for this class was generated from the following files: