ldap_count_references

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

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

Parameters

ld

[in] The session handle.

res

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

Return Values

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

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Functions, ldap_count_entries, ldap_count_values, ldap_first_entry, ldap_first_reference, ldap_next_entry, ldap_next_reference, ldap_result