ldap_search_s function (winldap.h)

Article
09/22/2022

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

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_search_s(
  [in]  LDAP         *ld,
  [in]  PSTR         base,
  [in]  ULONG        scope,
  [in]  PSTR         filter,
  [in]  PZPSTR       attrs,
  [in]  ULONG        attrsonly,
  [out] PLDAPMessage *res
);

Parameters

[in] ld

Session handle.

[in] base

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

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 indicating the attributes to return for each matching entry. Pass NULL to retrieve all available attributes.

[in] attrsonly

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

[out] res

Contains the results of the search upon completion of the call. Can also contain partial results or extended data when the function call fails with an error code. Free results returned with a call to ldap_msgfree when they are no longer required by the application.

Return value

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails it returns an error code, however ldap_search_s can fail and can still allocate pMsg. For example, both LDAP_PARTIAL_RESULTS and LDAP_REFERRAL error code allocate pMsg. For more information, see the following code example. For more information, see Return Values.

Remarks

The ldap_search_s function initiates a synchronous search.

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. For more information, see Session Options.

Upon completion of the search operation, ldap_search_s returns to the caller. Use ldap_search to have the operation performed asynchronously.

Multithreading: Calls to ldap_search_s are thread-safe.

The following code example shows how to free pMsg in the event that ldap_search_s fails.

// Initialize return value to NULL.
LDAPMessage *pMsg = NULL;

// Perform the search request.
dwErr = ldap_search_s (i_pldap,
        i_lpszBase,
        i_ulScope,
        i_lpszSearchFilter,
        lpszAttributes,
        0,
        &pMsg
        );

// Cleanup calling parameters.
if (lpszAttributes != NULL)
    delete [] lpszAttributes;

// Convert error code and cleanup pMsg, if necessary.
if (dwErr != LDAP_SUCCESS)
{
    DebugOutLDAPError(i_pldap, dwErr, _T("ldap_search_s"));
    hr = HRESULT_FROM_WIN32(dwErr);

    // Be aware that pMsg can contain valid data, even if the
    // call to ldap_search_s returned an error code.  
    // This can be caused by the server returning codes,
    // such as LDAP_RESULTS_TOO_LARGE or other codes,
    // that indicate that the search returned partial
    // results. The user code can handle these cases
    // if required, this example just frees pMsg on any 
    // error code.

    if (pMsg != NULL)
      ldap_msgfree(pMsg);
}

else
{
    // Process the search results.
    ...
    // Free the results when no longer required.
    if (pMsg != NULL) ldap_msgfree(pMsg);
}

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