ldap_compare_s function (winldap.h)

Use the ldap_compare_s function to determine whether an attribute for a given entry holds a known value.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_compare_s(
  [in] LDAP       *ld,
  [in] const PSTR dn,
  [in] const PSTR attr,
  [in] PSTR       value
);

Parameters

[in] ld

The session handle.

[in] dn

A pointer to a null-terminated string that contains the distinguished name of the entry.

[in] attr

A pointer to a null-terminated string that contains the attribute to compare.

[in] value

A pointer to a null-terminated string that contains the string attribute value to compare to the attribute value.

Return value

If the function succeeds, and the attribute and known values match, the return value is LDAP_COMPARE_TRUE. If the values do not match, the return value is LDAP_COMPARE_FALSE.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

The ldap_compare_s function initiates a synchronous compare operation, comparing the value of an attribute to a known string value. Use ldap_compare_ext_s if you need to compare binary values. Use ldap_compare or ldap_compare_ext to carry out an asynchronous compare operation.

Multithreading: Calls to ldap_compare_s are thread-safe.

Note  When connecting to an LDAP 2 server, the application must perform a bind operation (by calling one of the ldap_bind or ldap_simple_bind routines) before attempting any other operations.

 

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

ldap_bind

ldap_compare

ldap_compare_ext

ldap_compare_ext_s

ldap_simple_bind