ldap_pwdpolicy_err2string()--Convert the Numeric LDAP Password Policy Error or Warning Code into a String

Syntax

 #include <ldap.h>
 
 char *ldap_pwdpolicy_err2string(
              int err)

  Library Name/Service Program: QSYS/QGLDCLNT

  Default Public Authority: *USE

  Threadsafe: Yes

The ldap_pwdpolicy_err2string() function is used to convert a numeric LDAP password policy error or warning code, as returned by ldap_parse_pwdpolicy_response(), into a NULL-terminated character string that describes the error or warning. The character string is returned as static data and must not be freed by the caller.

The text description returned will be provided in English only.

Authorities and Locks

No IBM^® i authority is required..

Parameters

err: (Input) Specifies an integer value returned from ldap_parse_pwdpolicy_response() containing the password policy warning or error code.

Return Value

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

Error Conditions

The ldap_pwdpolicy_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_pwdpolicy_err2string API.

Related Information

ldap_parse_pwdpolicy_response() -- Obtain the LDAP Password Policy error or warning codes.
ldap_err2string() -- Convert LDAP error indication to a string.
ldap_result() -- Retrieve result of an asynchronous LDAP operation.
ldap_bind() -- Asynchronously bind to the directory (deprecated).
ldap_sasl_bind() -- Asynchronously bind to the directory using SASL.
ldap_err2string() -- Retrieve LDAP error message string.
ldap_result() -- Retrieve result of an asynchronous LDAP operation.

API introduced: V5R3

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