ldap_err2string function (winldap.h)

The ldap_err2string function converts a numeric LDAP error code into a null-terminated character string that describes the error.

Syntax

WINLDAPAPI PCHAR LDAPAPI ldap_err2string(
  [in] ULONG err
);

Parameters

[in] err

An LDAP error code as returned by another LDAP function.

Return value

If the function succeeds, a pointer to a null-terminated character string that describes the error, is returned.

If the function fails, a pointer to NULL is returned.

Remarks

Call ldap_err2string to convert any numeric LDAP error code into an informative, null-terminated character string message that describes the error. Be aware that some of the asynchronous calls return -1. In this case, use LdapGetLastError to retrieve the LDAP error code, and then use ldap_err2string on that value.

The return value is a static pointer to the character string. Do not free this string.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header winldap.h
Library Wldap32.lib
DLL Wldap32.dll

See also

Functions

Return Values