ldap_compare_s()--Perform an LDAP Compare Operation (Synchronous)

Syntax

 #include <ldap.h>
 
 int ldap_compare_s(
        LDAP           *ld,
        const char     *dn,
        const char     *attr,
        const char     *value)

  Library Name/Service Program: QSYS/QGLDCLNT

  Default Public Authority: *USE

  Threadsafe: Yes

The ldap_compare_s() function is used to perform an LDAP compare operation. The API uses as input the distinguished name (DN) of the entry on which to perform the compare, and uses an attr and value (the attribute type and value to compare to those found in the entry).

Binary values are not supported by this API. Use ldap_compare_ext_s() if binary values must be compared. ldap_compare_s() is a synchronous request.

Authorities and Locks

No IBM^® i authority is required. All authority checking is done by the LDAP server.

Parameters

ld: (Input) The LDAP pointer returned by a previous call to ldap_init(), ldap_ssl_init(), or ldap_open().
dn: (Input) The distinguished name (DN) of the entry upon which to perform the compare.
attr: (Input) The attribute type to use in the comparison.
value: (Input) The string attribute value to compare against the value in the entry.

Return Value

LDAP_COMPARE_TRUE: if the entry contains the attribute value.
LDAP_COMPARE_FALSE: if the entry does not contain the attribute value.
another LDAP error code: if the request was not successful.

Error Conditions

The ldap_compare_s() API will return an LDAP error code if not successful. See LDAP Client API Error Conditions for possible LDAP error code values.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_compare_s API.

Related Information

ldap_compare() -- Asynchronous compare to a directory entry.
ldap_compare_ext() -- Asynchronous compare to a directory entry with controls.
ldap_compare_ext_s() -- Synchronous compare to a directory entry with controls.

API introduced: V4R3

[ Back to top | LDAP APIs | APIs by category ]