ldap_search_extW function (winldap.h)

Article
02/09/2023

The ldap_search_ext function searches the LDAP directory and returns a requested set of attributes for each matched entry.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_search_extW(
  [in]  LDAP          *ld,
  [in]  const PWSTR   base,
  [in]  ULONG         scope,
  [in]  const PWSTR   filter,
  [in]  PZPWSTR       attrs,
  [in]  ULONG         attrsonly,
  [in]  PLDAPControlW *ServerControls,
  [in]  PLDAPControlW *ClientControls,
  [in]  ULONG         TimeLimit,
  [in]  ULONG         SizeLimit,
  [out] ULONG         *MessageNumber
);

Parameters

[in] ld

The session handle.

[in] base

A pointer to a null-terminated string that contains the distinguished name of the entry at which to start the search.

[in] scope

Specifies one of the following values to indicate the search scope.

LDAP_SCOPE_BASE

Search the base entry only.

LDAP_SCOPE_ONELEVEL

Search all entries in the first level below the base entry, excluding the base entry.

LDAP_SCOPE_SUBTREE

Search the base entry and all entries in the tree below the base.

[in] filter

A pointer to a null-terminated string that specifies the search filter. For more information, see Search Filter Syntax.

[in] attrs

A null-terminated array of null-terminated strings that indicate which attributes to return for each matching entry. To retrieve all available attributes, pass NULL.

[in] attrsonly

A Boolean value that should be zero if both attribute types and values are to be returned, nonzero if only types are to be returned.

[in] ServerControls

A list of LDAP server controls.

[in] ClientControls

A list of client controls.

[in] TimeLimit

Specifies both the local search time-out value in seconds and the operation time limit sent to the server within the search request.

[in] SizeLimit

A limit on the number of entries to return from the search. A value of zero indicates no limit.

[out] MessageNumber

The request message ID.

Return value

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. For more information, see Return Values.

Remarks

The ldap_search_ext function initiates an asynchronous search operation. The parameters and effects of ldap_search_ext include those of ldap_search. The extended function includes additional parameters to support client and server controls and thread safety, and to specify size and time limits for each search operation.

Use the ldap_set_option function with the ld session handle to set the LDAP_OPT_DEREF option that determine how the search is performed. For more information, see Session Options. Two other session options, LDAP_OPT_SIZELIMIT and LDAP_OPT_TIMELIMIT, are ignored in favor of the SizeLimit and TimeLimit parameters in this function.

If the operation succeeds, ldap_search_ext passes the message ID to the caller as a parameter when the operation returns successfully. Call ldap_result with the message ID to get the result of the operation.

An LDAP client application that must control the rate at which results are returned may specify the search request to provide a paged results control with size set to the desired page size and cookie set to the zero-length string. The page size specified may be greater than zero and less than the SizeLimit value specified in the search request.

If the page size is greater than or equal to the SizeLimit value option described in Session Options, the server should ignore the control because the request can be satisfied in a single page. If the server does not support this control, the server must return an error of unsupported Critical Extension if the client requested it as critical, otherwise the server should ignore the control. The remainder of this section assumes the server does not ignore the client's paged results control.

The client sends the server a search request with the simple paged results control, along with an empty previous enumeration key, also known as a "cookie," and the initial page size. The server then returns the number of entries specified by the page size and also returns a cookie issued on the next client request to get the next page of results. The client then issues a search, with the cookie included, optionally resetting the page size. The server then responds by returning the results, up to the specified number of entries. To instruct the function to return the results directly, use the synchronous routine ldap_search_ext_s.

Multithreading: Calls to ldap_search_ext are thread-safe.

Note

The winldap.h header defines ldap_search_ext as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	winldap.h
Library	Wldap32.lib
DLL	Wldap32.dll