ldap_first_message()--Retrieve First LDAP Message

Syntax #include <ldap.h> LDAPMessage *ldap_first_message(LDAP *ld, LDAPMessage *result) Threadsafe: Yes

The ldap_first_message() routine is used to step through the list of messages in a result chain, as returned by ldap_result(). It is used to return a pointer to the first message from the list.

Authorities and Locks

No OS/400 authority is required. All authority checking is done by the LDAP server.

Parameters

ld

(Input) Specifies the LDAP pointer returned by a previous call to ldap_init(),ldap_ssl_init(), or ldap_open().

result

(Input) Specifies the result returned by a call to ldap_result() or one of the synchronous search routines (ldap_search_s(), ldap_search_st() or ldap_search_ext_s()).

Return Value

LDAPMessage *

pointer to the first message.

NULL

when no more messages exist in the result set to be returned or if an error occurs.

Error Conditions

If ldap_first_message() is not successful, ld_errno will be set to indicate the error. See LDAP Client API Error Conditions for possible LDAP error code values. Use ldap_get_errno() function to retrieve the error information.

Error Messages

    The following message may be set from this function.
    CPF3CF2 E  Error(s) occurred during running of ldap_first_message API.

Related Information

    ldap_count_message() -- Return the number of message in a result chain, as returned by ldap_result.
    ldap_next_message() -- Return next message in a result chain, as returned by ldap_result.