Share via


ldap_count_references (Compact 2013)

3/26/2014

This function counts the number of subordinate references that were returned by the server in a response to a search request.

Syntax

ULONG ldap_count_references(
  LDAP* ld,
  LDAPMessage* res
);

Parameters

  • ld
    [in] Session handle.
  • res
    [in] Search result obtained by a call to one of the synchronous search routines or to the ldap_result function.

Return Value

If this function succeeds, it returns the number of references.

If this function fails, it returns -1 and sets the session error parameters in the LDAP data structure.

Remarks

This function returns the number of references contained in a chain of search results. It can also be used to count the number of references that remain in a chain. Call the function with the return value from ldap_first_entry, ldap_next_entry, ldap_first_reference, ldap_next_reference, or ldap_result.

Requirements

Header

winldap.h

Library

wldap32.lib

See Also

Reference

LDAP Search Functions
ldap_count_entries
ldap_count_values
ldap_first_entry
ldap_first_reference
ldap_next_entry
ldap_next_reference
ldap_result