1LDAP_FIRST_MESSAGE(3)      Library Functions Manual      LDAP_FIRST_MESSAGE(3)
2
3
4

NAME

6       ldap_first_message,  ldap_next_message,  ldap_count_messages - Stepping
7       through messages in a result chain
8

LIBRARY

10       OpenLDAP LDAP (libldap, -lldap)
11

SYNOPSIS

13       #include <ldap.h>
14
15       int ldap_count_messages( LDAP *ld, LDAPMessage *result )
16
17       LDAPMessage *ldap_first_message( LDAP *ld, LDAPMessage *result )
18
19       LDAPMessage *ldap_next_message( LDAP *ld, LDAPMessage *message )
20

DESCRIPTION

22       These routines are used to step through the messages in a result  chain
23       received  from ldap_result(3).  For search operations, the result chain
24       can contain referral, entry and result  messages.  The  ldap_msgtype(3)
25       function  can  be  used  to  distinguish  between the different message
26       types.
27
28       The ldap_first_message() routine is used to retrieve the first  message
29       in  a  result  chain.   It  takes  the  result as returned by a call to
30       ldap_result(3), ldap_search_s(3) or  ldap_search_st(3)  and  returns  a
31       pointer to the first message in the result chain.
32
33       This  pointer should be supplied on a subsequent call to ldap_next_mes‐
34       sage() to get the next message, the result of which should be  supplied
35       to the next call to ldap_next_message(), etc.  ldap_next_message() will
36       return NULL when there are no more messages.
37
38       These functions are useful  when  using  routines  like  ldap_parse_re‐
39       sult(3) that only operate on the first result in the chain.
40
41       A  count  of the number of messages in the result chain can be obtained
42       by calling ldap_count_messages().  It can also be  used  to  count  the
43       number of remaining messages in a chain if called with a message, entry
44       or reference returned by ldap_first_message() ,  ldap_next_message()  ,
45       ldap_first_entry(3),    ldap_next_entry(3),    ldap_first_reference(3),
46       ldap_next_reference(3).
47

ERRORS

49       If an error occurs in ldap_first_message() or ldap_next_message(), NULL
50       is  returned.   If  an error occurs in ldap_count_messages(), -1 is re‐
51       turned.
52

SEE ALSO

54       ldap(3),    ldap_search(3),    ldap_result(3),    ldap_parse_result(3),
55       ldap_first_entry(3), ldap_first_reference(3)
56

ACKNOWLEDGEMENTS

58       OpenLDAP  Software  is developed and maintained by The OpenLDAP Project
59       <http://www.openldap.org/>.  OpenLDAP Software is derived from the Uni‐
60       versity of Michigan LDAP 3.3 Release.
61
62
63
64OpenLDAP                          2021/06/03             LDAP_FIRST_MESSAGE(3)
Impressum