ldap_count_messages

Returns the number of LDAPMessage structures of any type in an LDAP message chain.

LDAP Version:v3
Library:*ldapsdk.*
NDS Version:7.xx or higher
Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

  #include <ldap.h>
  
  int ldap_count_messages (
     LDAP          *ld,
     LDAPMessage   *res);

Parameters

ld

(IN) Points to the handle for the LDAP session.

res

(IN) Points to the result message chain returned by the ldap_result function or a synchronous search function.

Return Values

>0

Number of messages in the chain

0

No more messages

-1

Failure

Remarks

The ldap_count_messages function can be used to count the number of message structures that remain in a chain. The following functions are used to iterate through the chain:

  • ldap_first_message

  • ldap_next_message

  • ldap_first_reference

  • ldap_next_reference

This function counts from the current position of the pointer to the end of the chain.

  • If you pass a pointer that points to the first message structure in the chain, it counts all the messages in the chain.

  • If you pass a pointer that points to a structure in the middle of the chain, it counts the messages from that point to the end of the chain.

See Also

ldap_first_message, ldap_next_message, ldap_search, ldap_search_ext, ldap_search_ext_s, ldap_search_s, ldap_search_st