ldap_set_lderrno

Sets error information in an LDAP structure. This function has been deprecated; use the ldap_set_option function.

LDAP Version:v2 or higher
Library:*ldapsdk.*
NDS Version:7.xx or higher
Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

  #include <ldap.h>
  
  int   ldap_set_lderrno (
     LDAP   *ld,
     int     errnum,
     char   *matchedDN,
     char   *errmsg);

Parameters

ld

(IN) Points to the handle for the LDAP session.

errnum

(IN) Specifies the LDAP error number to set.

matchedDN

(IN) Points to the name of the lowest entry in the directory that was matched on the search operation. May be NULL.

errmsg

(IN) Points to a text string that contains information from the LDAP server about this error. May be NULL.

Return Values

Always returns LDAP_SUCCESS.

Remarks

The ldap_set_lderrno function can be used to add or modify information about an error in an LDAP handle. This information can be retrieved in a subsequent call to the ldap_get_lderrno function.

The LDAP libraries make a copy of the string before storing it in the LDAP handle, so you do not need to preserve the original string after the call.

NOTE:This is not a standard IETF function. It has been added for compatibility with other LDAP vendors' libraries and should not be used in new applications. Use the ldap_set_option function with LDAP_OPT_ERR_NUMBER, LDAP_OPT_MATCHED_DN, and LDAP_OPT_ERROR_STRING.

See Also

ldap_get_lderrno, ldap_set_option