Discuss this help topic in SecureBlackbox Forum

TElLDAPSClient.Search

TElLDAPSClient     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Performs search on LDAP server.

Declaration

[C#/Java]
    virtual TElLDAPResponse Search(string BaseDN, TSBLDAPScope Scope, string Filter, StringArray Attrs, bool AttrsOnly);
    virtual TElLDAPResponse Search(string BaseDN, TSBLDAPScope Scope, TElLDAPSSearchFilter Filter, StringArray Attrs, bool AttrsOnly);
    virtual TElLDAPResponse Search();

[VB.NET]
    Overridable Function Search(ByVal BaseDN As String, ByVal Scope As TSBLDAPScope, ByVal Filter As String, ByVal Attrs As StringArray, ByVal AttrsOnly As Boolean) As TElLDAPResponse
    Overridable Function Search(ByVal BaseDN As String, ByVal Scope As TSBLDAPScope, ByVal Filter As TElLDAPSSearchFilter, ByVal Attrs As StringArray, ByVal AttrsOnly As Boolean) As TElLDAPResponse
    Overridable 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:


Return value

    Returns server response.

Description

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

See also:     SearchURL     Attributes     AttributesOnly     BaseDN     Filter     Scope    

Discuss this help topic in SecureBlackbox Forum