LDAP_FIRST_MESSAGE(3LDAP) LDAP Library Functions LDAP_FIRST_MESSAGE(3LDAP)
NAME
ldap_first_message, ldap_count_messages, ldap_next_message, ldap_msgtype
- LDAP message processing functions
SYNOPSIS
cc[
flag... ]
file... -lldap[
library... ]
#include <lber.h>
#include <ldap.h>
int ldap_count_messages(
LDAP *ld,
LDAPMessage *res);
LDAPMessage *ldap_first_message(
LDAP *ld,
LDAPMessage *res);
LDAPMessage *ldap_next_message(
LDAP *ld,
LDAPMessage *msg);
int ldap_msgtype(
LDAPMessage *res);
DESCRIPTION
ldap_count_messages() is used to count the number of messages that remain
in a chain of results if called with a message, entry, or reference
returned by
ldap_first_message(),
ldap_next_message(),
ldap_first_entry(),
ldap_next_entry(),
ldap_first_reference(), and
ldap_next_reference() ldap_first_message() and
ldap_next_message() functions are used to step
through the list of messages in a result chain returned by
ldap_result().
ldap_msgtype() function returns the type of an LDAP message.
RETURN VALUES
ldap_first_message() and
ldap_next_message() return
LDAPMessage which
can include referral messages, entry messages and result messages.
ldap_count_messages() returns the number of messages contained in a chain
of results.
ERRORS
ldap_first_message() and
ldap_next_message() return
NULL when no more
messages exist.
NULL is also returned if an error occurs while stepping
through the entries, in which case the error parameters in the session
handle
ld will be set to indicate the error.
ATTRIBUTES
See
attributes(7) for a description of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|Interface Stability | Evolving |
+--------------------+-----------------+
SEE ALSO
ldap_error(3LDAP),
ldap_result(3LDAP),
attributes(7) January 27, 2002
LDAP_FIRST_MESSAGE(3LDAP)