ldap_msgtype(3LDAP)

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO

NAME

ldap_first_message, ldap_count_messages, ldap_next_message, ldap_msgtype- LDAP message processing functions

SYNOPSIS

cc[ flag... ] file... -lldap[ library... ]
$(OS_DIR)/lib/libldap.a
#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);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

DESCRIPTION

The ldap_count_messages() function 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(3LDAP) , ldap_next_entry(3LDAP) , ldap_first_reference(3LDAP) , and ldap_next_reference(3LDAP) .

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(3LDAP) .

The 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.

The ldap_count_messages() function returns the number of messages contained in a chain of results.

ERRORS

The ldap_first_message() and ldap_next_message() functions 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 descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

ldap_error(3LDAP) , ldap_result(3LDAP)

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO