ldap_err2string()--Retrieve LDAP Error Message String

Syntax #include <ldap.h> char *ldap_err2string( int error) 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 OS/400 authority is required. All authority checking is done by the LDAP server.

Parameters

error

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

Return Value

LDAP error description String

which is a textual description of the LDAP error code.

Error Conditions

ldap_err2string() will return "Unknown Error" message 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 set from this function.
    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.