ldap_count_references()--Count continuation references in a chain of search results

Syntax

 #include <ldap.h>
 

 int ldap_count_references(LDAP         *ld,
                           LDAPMessage  *result)

  Library Name/Service Program: QSYS/QGLDCLNT

  Default Public Authority: *USE

  Threadsafe: Yes

The ldap_count_references() API is used to count the number of continuation references returned. It can also be used to count the number of continuation references that remain in a chain.

Authorities and Locks

No IBM^® i authority is required.

Parameters

ld: (Input) The LDAP pointer returned by a previous call to ldap_init(), ldap_ssl_init(), or ldap_open().
result: (Input) The result returned by a call to ldap_result() or one of the synchronous search routines (ldap_search_s(), ldap_search_st(), or ldap_search_ext_s()).

Return Value

Number of continuation reference: If the request was successful, ldap_count_references() API returns the number of continuation references in a result chain or number of continuation references that remain in a chain, as returned by ldap_result().
-1: if the request was not successful.

Error Conditions

If ldap_count_references() is not successful, ld_errno will be set to indicate the error. See LDAP Client API Error Conditions for possible LDAP error code values. Use ldap_get_errno() function to retrieve the error information.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_count_references API.

Related Information

ldap_first_reference() -- Return first continuation reference in a result chain, as returned by ldap_result.
ldap_next_reference() -- Return next continuation reference in a result chain, as returned by ldap_result.

API introduced: V4R5

[ Back to top | LDAP APIs | APIs by category ]