ldap_err2string()--Retrieve LDAP Error Message String

Syntax

 #include <ldap.h>

 char *ldap_err2string(
        int          error)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_err2string() function is used to retrieve the text description corresponding to an LDAP error code.

The text description returned will be provided in English only.

The string returned from ldap_err2string() should not be freed when use of the string is complete.

Authorities and Locks

No IBM^® i authority is required.

Parameters

error: (Input) Specifies the LDAP error code returned by a previous call to ldap_result2error(), ldap_get_errno(), or a synchronous LDAP API.

Return Value

LDAP error description String: a textual description of the LDAP error code.

Error Conditions

The ldap_err2string() API will return "Unknown Error" if the LDAP error code is unknown. See LDAP Client API Error Conditions for possible LDAP error codes and their description.

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_err2string API.

Related Information

ldap_get_errno() -- Retrieve Error Code set.
ldap_perror() -- Print an LDAP error indication to standard error.
ldap_result2error() -- Extract LDAP error indication from LDAP result.

API introduced: V4R3

[ Back to top | LDAP APIs | APIs by category ]