Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ldap_msgtype(3ldap) [opensolaris man page]

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 refer- ence 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(5) for a description of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |Availability |SUNWcsl (32-bit) | | |SUNWcslx (64-bit) | |Interface Stability |Evolving | +-----------------------------+-----------------------------+ SEE ALSO
ldap_error(3LDAP), ldap_result(3LDAP), attributes(5) SunOS 5.11 27 Jan 2002 ldap_first_message(3LDAP)

Check Out this Related Man Page

LDAP_FIRST_MESSAGE(3)					     Library Functions Manual					     LDAP_FIRST_MESSAGE(3)

NAME
ldap_first_message, ldap_next_message, ldap_count_messages - Stepping through messages in a result chain LIBRARY
OpenLDAP LDAP (libldap, -lldap) SYNOPSIS
#include <ldap.h> int ldap_count_messages( LDAP *ld, LDAPMessage *result ) LDAPMessage *ldap_first_message( LDAP *ld, LDAPMessage *result ) LDAPMessage *ldap_next_message( LDAP *ld, LDAPMessage *message ) DESCRIPTION
These routines are used to step through the messages in a result chain received from ldap_result(3). For search operations, the result chain can contain referral, entry and result messages. The ldap_msgtype(3) function can be used to distinguish between the different mes- sage types. The ldap_first_message() routine is used to retrieve the first message in a result chain. It takes the result as returned by a call to ldap_result(3), ldap_search_s(3) or ldap_search_st(3) and returns a pointer to the first message in the result chain. This pointer should be supplied on a subsequent call to ldap_next_message() to get the next message, the result of which should be supplied to the next call to ldap_next_message(), etc. ldap_next_message() will return NULL when there are no more messages. These functions are useful when using routines like ldap_parse_result(3) that only operate on the first result in the chain. A count of the number of messages in the result chain can be obtained by calling ldap_count_messages(). It can also be used to count the number of remaining messages in a chain if called with a message, entry or reference returned by ldap_first_message() , ldap_next_message() , ldap_first_entry(3), ldap_next_entry(3), ldap_first_reference(3), ldap_next_reference(3). ERRORS
If an error occurs in ldap_first_message() or ldap_next_message(), NULL is returned. If an error occurs in ldap_count_messages(), -1 is returned. SEE ALSO
ldap(3), ldap_search(3), ldap_result(3), ldap_parse_result(3), ldap_first_entry(3), ldap_first_reference(3) ACKNOWLEDGEMENTS
OpenLDAP Software is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>. OpenLDAP Software is derived from the University of Michigan LDAP 3.3 Release. OpenLDAP 2017/06/01 LDAP_FIRST_MESSAGE(3)
Man Page