TElLDAPSClient.Search method

TElLDAPSClient.Search

Performs search on LDAP server.

Declaration

[VB.NET]
    Function Search(ByVal BaseDN As String, ByVal Scope As TSBLDAPScope, ByVal Filter As String, ByVal Attrs As String[], ByVal AttrsOnly As Boolean) As TElLDAPResponse
    Function Search(ByVal BaseDN As String, ByVal Scope As TSBLDAPScope, ByVal Filter As TElLDAPSSearchFilter, ByVal Attrs As String[], ByVal AttrsOnly As Boolean) As TElLDAPResponse
    Function Search() As TElLDAPResponse

[Pascal]
    function Search(const BaseDN : string; const Scope : TSBLDAPScope; Filter : string; const Attrs : array of string; const AttrsOnly : boolean) : TElLDAPResponse; virtual;
    function Search(const BaseDN : string; const Scope : TSBLDAPScope; const Filter : TElLDAPSSearchFilter; const Attrs : array of string; const AttrsOnly : boolean) : TElLDAPResponse; virtual;
    function Search : TElLDAPResponse; virtual;

[C++]
    TElLDAPResponseHandle Search(const std::string &BaseDN, TSBLDAPScope Scope, const std::string &Filter, const TStringList &Attrs, bool AttrsOnly);
    TElLDAPResponseHandle Search(const std::string &BaseDN, TSBLDAPScope Scope, const TElLDAPSSearchFilter &Filter, const TStringList &Attrs, bool AttrsOnly);
    TElLDAPResponseHandle Search(const std::string &BaseDN, TSBLDAPScope Scope, const TElLDAPSSearchFilter *Filter, const TStringList &Attrs, bool AttrsOnly);
    TElLDAPResponseHandle Search();

[PHP]
    TElLDAPResponse Search(string $BaseDN, integer $Scope, string $Filter, TStringList $Attrs, bool $AttrsOnly)
    TElLDAPResponse Search(string $BaseDN, integer $Scope, TElLDAPSSearchFilter $Filter, TStringList $Attrs, bool $AttrsOnly)
    TElLDAPResponse Search()

Parameters

Attrs - list of the attributes to be returned from each entry that matches the search filter
AttrsOnly - if set to True, only attribute values are requested. Otherwise, both attribute descriptions and values are requested.
BaseDN - Distinguished Name of the entry from which to start the search
Filter - specifies search filter (criteria)
Scope - specifies the scope of the search to be performed

Scope values:

[.NET] [C++]	[Pascal]	Description
scBase = 0	scBase	The scope is constrained to the base object (root) relative to which the search is performed.
scOneLevel = 1	scOneLevel	The scope is constrained to the immediate subordinates of the base object.
scSubTree = 2	scSubTree	The scope is constrained to the base object and to all its subordinates.

Return value

Returns server response.

Description

Use this method to perform search for the desired entries in the LDAP database.