KLDAP::LdapSearch Class Reference

#include <ldapsearch.h>

Inherits QObject.

Signals
void	data (KLDAP::LdapSearch *search, const KLDAP::LdapObject &obj)
void	result (KLDAP::LdapSearch *search)

Public Member Functions
	LdapSearch ()
	LdapSearch (LdapConnection &connection)
void	abandon ()
void	continueSearch ()
int	error () const
QString	errorString () const
bool	isFinished ()
bool	search (const LdapServer &server, const QStringList &attributes=QStringList(), int count=0)
bool	search (const LdapUrl &url, int count=0)
bool	search (const LdapDN &base, LdapUrl::Scope scope=LdapUrl::Sub, const QString &filter=QString(), const QStringList &attributes=QStringList(), int pagesize=0, int count=0)
void	setClientControls (const LdapControls &ctrls)
void	setConnection (LdapConnection &connection)
void	setServerControls (const LdapControls &ctrls)

Detailed Description

This class starts a search operation on a LDAP server and returns the search values via a Qt signal.

Definition at line 45 of file ldapsearch.h.

Constructor & Destructor Documentation

LdapSearch::LdapSearch

(

)

Constructs an LdapSearch object.

Definition at line 251 of file ldapsearch.cpp.

LdapSearch::LdapSearch ( LdapConnection &  connection )

explicit

Constructs an LdapConnection object with the given connection.

If this form of constructor used, then always this connection will be used regardless of the LDAP Url or LdapServer object passed to search().

Parameters

connection

the connection used to construct LdapConnection object

Definition at line 258 of file ldapsearch.cpp.

Member Function Documentation

void LdapSearch::abandon

(

)

Tries to abandon the search.

Definition at line 337 of file ldapsearch.cpp.

void LdapSearch::continueSearch

(

)

Continues the search (if you set count to non-zero in search(), and isFinished() is false)

Definition at line 325 of file ldapsearch.cpp.

void KLDAP::LdapSearch::data ( KLDAP::LdapSearch *  search, const KLDAP::LdapObject &  obj  )

signal

Emitted for each result object.

int LdapSearch::error

(

)

const

Returns the error code of the search operation (0 if no error).

Definition at line 342 of file ldapsearch.cpp.

QString LdapSearch::errorString

(

)

const

Returns the error description of the search operation.

Definition at line 347 of file ldapsearch.cpp.

bool LdapSearch::isFinished

(

)

Returns true if the search is finished else returns false.

Definition at line 332 of file ldapsearch.cpp.

void KLDAP::LdapSearch::result ( KLDAP::LdapSearch *  search )

signal

Emitted when the searching finished.

bool LdapSearch::search	(	const LdapServer &	server,
		const QStringList &	attributes = QStringList(),
		int	count = 0
	)

Starts a search operation on the LDAP server.

Parameters

server,returning	the attributes specified with
attributes.
count	means how many entries to list. If it's >0, then result() will be emitted when the number of entries is reached, but with isFinished() set to false.

Definition at line 288 of file ldapsearch.cpp.

bool LdapSearch::search	(	const LdapUrl &	url,
		int	count = 0
	)

Starts a search operation on the given LDAP URL.

Definition at line 302 of file ldapsearch.cpp.

bool LdapSearch::search	(	const LdapDN &	base,
		LdapUrl::Scope	scope = LdapUrl::Sub,
		const QString &	filter = QString(),
		const QStringList &	attributes = QStringList(),
		int	pagesize = 0,
		int	count = 0
	)

Starts a search operation if the LdapConnection object already set in the constructor.

Definition at line 317 of file ldapsearch.cpp.

void LdapSearch::setClientControls

(

const LdapControls &

ctrls

)

Sets the client controls which will sent with each operation.

Definition at line 278 of file ldapsearch.cpp.

void LdapSearch::setConnection

(

LdapConnection &

connection

)

Sets the connection for this object to use for searches from now onwards, regardless of the LDAP Url or LdapServer object passed to search().

Definition at line 271 of file ldapsearch.cpp.

void LdapSearch::setServerControls

(

const LdapControls &

ctrls

)

Sets the server controls which will sent with each operation.

Definition at line 283 of file ldapsearch.cpp.

---

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

• ldapsearch.h
• ldapsearch.cpp