2.1 LDAP Client Return Codes

The LDAP client or libraries return codes set the following return codes.

Table 2-1 LDAP Client Return Codes

Hex

Decimal

Constant: Description

0x51

81

LDAP_SERVER_DOWN: Indicates that the LDAP libraries cannot establish an initial connection with the LDAP server. Either the LDAP server is down or the specified host name or port number is incorrect.

0x52

82

LDAP_LOCAL_ERROR: Indicates that the LDAP client has an error. This is usually a failed dynamic memory allocation error.

0x53

83

LDAP_ENCODING_ERROR: Indicates that the LDAP client encountered errors when encoding an LDAP request intended for the LDAP server.

0x54

84

LDAP_DECODING_ERROR: Indicates that the LDAP client encountered errors when decoding an LDAP response from the LDAP server.

0x55

85

LDAP_TIMEOUT: Indicates that the time limit of the LDAP client was exceeded while waiting for a result.

0x56

86

LDAP_AUTH_UNKNOWN: Indicates that the ldap_bind or ldap_bind_s function was called with an unknown authentication method.

0x57

87

LDAP_FILTER_ERROR: Indicates that the ldap_search function was called with an invalid search filter.

0x58

88

LDAP_USER_CANCELLED: Indicates that the user cancelled the LDAP operation.

0x59

89

LDAP_PARAM_ERROR: Indicates that an LDAP function was called with an invalid parameter value (for example, the ld parameter is NULL).

0x5A

90

LDAP_NO_MEMORY: Indicates that a dynamic memory allocation function failed when calling an LDAP function.

0x5B

91

LDAP_CONNECT_ERROR: Indicates that the LDAP client has lost either its connection or cannot establish a connection to the LDAP server.

0x5C

92

LDAP_NOT_SUPPORTED: Indicates that the requested functionality is not supported by the client. For example, if the LDAP client is established as an LDAPv2 client, the libraries set this error code when the client requests LDAPv3 functionality.

0x5D

93

LDAP_CONTROL_NOT_FOUND: Indicates that the client requested a control that the libraries cannot find in the list of supported controls sent by the LDAP server.

0x5E

94

LDAP_NO_RESULTS_RETURNED: Indicates that the LDAP server sent no results. When the ldap_parse_result function is called, no result code is included in the server's response.

0x5F

95

LDAP_MORE_RESULTS_TO_RETURN: Indicates that more results are chained in the result message. The libraries set this code when the call to the ldap_parse_result function reveals that additional result codes are available.

0x60

96

LDAP_CLIENT_LOOP: Indicates the LDAP libraries detected a loop. Usually this happens when following referrals.

0x61

97

LDAP_REFERRAL_LIMIT_EXCEEDED: Indicates that the referral exceeds the hop limit. The hop limit determines how many servers the client can hop through to retrieve data. For example, suppose the following conditions:

  • The hop limit is two.

  • The referral is to server D which can be contacted only through server B (1 hop) which contacts server C (2 hops) which contacts server D (3 hops)

With these conditions, the hop limit is exceeded and the LDAP libraries set this code.