ldap_count_references function (winldap.h)

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

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_count_references(
  [in] LDAP        *ld,
  [in] LDAPMessage *res
);

Parameters

[in] ld

The session handle.

[in] res

The search result obtained by a call to one of the synchronous search routines or to ldap_result.

Return value

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

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

Remarks

The ldap_count_references 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

See also

Functions

ldap_count_entries

ldap_count_values

ldap_first_entry

ldap_first_reference

ldap_next_entry

ldap_next_reference

ldap_result