ldap_compare_s

Synchronously determines whether a specified entry contains a specified attribute value.

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_compare_s (
     LDAP         *ld,
     const char   *dn,
     const char   *attr,
     const char   *value);
  
  

Parameters

ld

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

dn

(IN) Points to the distinguished name of the entry whose attribute is being compared.

attr

(IN) Points to the name of the attribute to compare.

value

(IN) Points to a string value of the attribute to compare.

Return Values

0x05

LDAP_COMPARE_FALSE: the entry does not contain the attribute value.

0x06

LDAP_COMPARE_TRUE: the entry contains the attribute value

Non-zero value other than 0x05 or 0x06

Failure. For a complete list, see LDAP Return Codes.

0x53

LDAP_ENCODING_ERROR

0x5A

LDAP_NO_MEMORY

Remarks

The ldap_compare_s function takes the attribute and its value and compares them to those found in the specified entry (dn).

The ldap_compare_s function is an older function. LDAP v3 clients should use the ldap_compare_ext_s function.

This function can compare only attributes with string values. Use ldap_compare_ext_s to compare binary values.

Compare operations are faster than search operations. Whenever possible in your application, use a compare rather than a search operation.

See Also

ldap_compare_ext