ldap_msgid()--Retrieve the Message ID Associated with an LDAP Message

Syntax #include <ldap.h> int ldap_msgid( LDAPMessage *msg) Threadsafe: Yes

The ldap_msgid() routine returns the message ID associated with the LDAP message passed as input (via the msg parameter).

Authorities and Locks

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

Parameters

msg

(Input) Specifies a pointer to a result, as returned from ldap_result(),ldap_search_s(), ldap_search_st() or ldap_search_ext().

Return Value

Message ID

if the call was successful.

ZERO

if the input pointer to LDAPMessage structure is NULL.

Error Conditions

ldap_msgid() return ZERO if the input pointer to LDAPMessage structure is NULL.

Error Messages

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

Related Information

    ldap_result() -- Wait for result from an asynchronous operation.
    ldap_msgtype() -- Returns the type of an LDAP message.