LDAP_COMPARE(3) Library Functions Manual LDAP_COMPARE(3)
NAME
ldap_compare, ldap_compare_s, ldap_compare_ext, ldap_compare_ext_s -
Perform an LDAP compare operation.
LIBRARY
OpenLDAP LDAP (libldap, -lldap)
SYNOPSIS
#include <ldap.h>
int ldap_compare_ext(
LDAP *ld,
char *dn,
char *attr,
const struct berval *bvalue,
LDAPControl **serverctrls,
LDAPControl **clientctrls,
int *msgidp );
int ldap_compare_ext_s(
LDAP *ld,
char *dn,
char *attr,
const struct berval *bvalue,
LDAPControl **serverctrls,
LDAPControl **clientctrls );
DESCRIPTION
The ldap_compare_ext_s() routine is used to perform an LDAP compare op-
eration synchronously. It takes dn, the DN of the entry upon which to
perform the compare, and attr and value, the attribute description and
value to compare to those found in the entry. It returns a code, which
will be LDAP_COMPARE_TRUE if the entry contains the attribute value and
LDAP_COMPARE_FALSE if it does not. Otherwise, an error code is re-
turned that indicates the nature of the problem. See ldap(3) for de-
tails.
The ldap_compare_ext() routine is used to perform an LDAP compare oper-
ation asynchronously. It takes the same parameters as ldap_com-
pare_ext_s(), but provides the message id of the request it initiated
in the integer pointed to msgidp. The result of the compare can be ob-
tained by a subsequent call to ldap_result(3).
Both routines allow server and client controls to be specified to ex-
tend the compare request.
DEPRECATED INTERFACES
The routines ldap_compare() and ldap_compare_s() are deprecated in fa-
vor of ldap_compare_ext() and ldap_compare_ext_s(), respectively.
Deprecated interfaces generally remain in the library. The macro
LDAP_DEPRECATED can be defined to a non-zero value (e.g., -DLDAP_DEPRE-
CATED=1) when compiling program designed to use deprecated interfaces.
It is recommended that developers writing new programs, or updating old
programs, avoid use of deprecated interfaces. Over time, it is ex-
pected that documentation (and, eventually, support) for deprecated in-
terfaces to be eliminated.
SEE ALSO
ldap(3), ldap_error(3)
ACKNOWLEDGEMENTS
OpenLDAP Software is developed and maintained by The OpenLDAP Project
<http://www.openldap.org/>. OpenLDAP Software is derived from the Uni-
versity of Michigan LDAP 3.3 Release.
OpenLDAP 2.5.18+dfsg-0ubuntu0.22.02024/05/21 LDAP_COMPARE(3)
Generated by dwww version 1.14 on Fri Jan 24 06:05:33 CET 2025.