ldap_search_s

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

ULONG ldap_search_s(
  LDAP* ld,
  UNICODE PTCHAR base,
  ULONG scope,
  UNICODE PTCHAR filter,
  UNICODE PTCHAR attrs[],
  ULONG attrsonly,
  LDAPMessage** res
);

Parameters

• ld
  [in] Session handle.

• base
  [in] Distinguished name of the entry at which to start the search.

• scope
  [in] Specifies a value to indicate the scope of the search. The following table shows the possible values.

  Value	Description
  LDAP_SCOPE_BASE	Searches the base entry only.
  LDAP_SCOPE_ONELEVEL	Searches all entries in the first level below the base entry, excluding the base entry.
  LDAP_SCOPE_SUBTREE	Searches the base entry and all entries in the tree below the base.

• filter
  [in] Pointer to a null-terminated string that specifies the search filter.

• attrs
  [in] Null-terminated array of strings indicating the attributes to return for each matching entry. Pass NULL to retrieve all available attributes.

• attrsonly
  [in] Boolean value that should be zero if both attribute types and values are to be returned and nonzero if only types are wanted.

• res
  [out] Contains the results of the search upon completion of the call.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

If this function fails, it returns an error code; however, this function can fail and can still allocate pMsg. See the example below for handling this behavior. See the LDAP_RETCODE enumeration for a list of possible return values.

Remarks

This function initiates a synchronous search operation.

You can use the ldap_set_option function with the ld session handle to set the LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, and LDAP_OPT_DEREF options that determine how the search is performed.

Upon completion of the search operation, ldap_search_s returns to the caller. Use ldap_search if you prefer to have the operation carried out asynchronously.

In a multithreading environment, calls to ldap_search_s are thread-safe.

Requirements

See Also

Reference

LDAP_RETCODE
ldap_search
ldap_set_option