ldap_msgid()--Retrieve the Message ID Associated with an LDAP Message
Syntax
#include <ldap.h> int ldap_msgid( LDAPMessage *msg)
Default Public Authority: *USE
Library Name/Service Program: QSYS/QGLDCLNT
Threadsafe: Yes
The ldap_msgid() routine returns the message ID associated with an LDAP message. Use ldap_msgid() to match the result(s) of an asynchronous operation with the original operation.
Authorities and Locks
No IBM® i authority is required.
Parameters
- msg
- (Input) Specifies a pointer to a result, as returned from ldap_first_message(),
ldap_next_message, ldap_first_entry(),
ldap_next_entry(), ldap_first_reference(), or ldap_next_reference().
Return Value
- Message ID
- if the call was successful.
- ZERO
- if the input pointer to LDAPMessage structure is NULL.
Error Conditions
ldap_msgid() returns ZERO if the input pointer to LDAPMessage structure is NULL.
Error Messages
The following message may be sent from this function.
Message ID | Error Message Text |
---|---|
CPF3CF2 E | Error(s) occurred during running of ldap_msgid API. |
Related Information
- ldap_add() -- Perform an LDAP add operation.
- ldap_add_ext() -- Perform an LDAP add operation with controls.
- ldap_bind() -- Perform an LDAP bind request.
- ldap_compare() -- Perform an LDAP compare operation.
- ldap_compare_ext() -- Perform an LDAP compare operation with controls.
- ldap_delete() -- Perform an LDAP delete operation.
- ldap_delete_ext() -- Perform an LDAP delete operation with controls.
- ldap_extended_operation() -- Perform extended operations.
- ldap_first_entry() -- Retrieve first LDAP entry.
- ldap_first_message() -- Retrieve First LDAP message.
- ldap_first_reference() -- Return first continuation reference in a chain of search results.
- ldap_modify() -- Perform an LDAP modify entry request.
- ldap_modify_ext() -- Perform an LDAP modify entry request with controls.
- ldap_modrdn() -- Perform an LDAP modify RDN request.
- ldap_msgtype() -- Returns the type of an LDAP message.
- ldap_next_entry() -- Retrieve next LDAP entry.
- ldap_next_message() -- Retrieve Next LDAP message.
- ldap_next_reference() -- Retrieve next continuation reference in a chain of search results.
- ldap_rename() -- Asynchronously rename an entry.
- ldap_result() -- Wait for result from an asynchronous operation.
- ldap_sasl_bind() -- Perform an LDAP SASL bind request.
- ldap_search() -- Perform an LDAP search operation.
- ldap_search_ext() -- Asynchronously search the directory using controls.
- ldap_simple_bind() -- Perform a simple LDAP bind request.
API introduced: V4R5
[ Back to top | LDAP APIs | APIs by category ]