LDAP_COMPARE(3LDAP) LDAP Library Functions LDAP_COMPARE(3LDAP)

NAME

ldap_compare, ldap_compare_s, ldap_compare_ext, ldap_compare_ext_s - LDAP
compare operation

SYNOPSIS

cc[ flag... ] file... -lldap[ library... ]
#include <lber.h>
#include <ldap.h>

int ldap_compare(LDAP *ld, char *dn, char *attr, char *value);


int ldap_compare_s(LDAP *ld, char *dn, char *attr, char *value);


int ldap_compare_ext(LDAP *ld, char *dn, char *attr,
struct berval *bvalue, LDAPControl **serverctrls,
LDAPControl **clientctrls,int *msgidp);


int ldap_compare_ext_s(LDAP *ld, char *dn, char *attr,
struct berval *bvalue, LDAPControl **serverctrls,
LDAPControl **clientctrls);

DESCRIPTION

The ldap_compare_s() function is used to perform an LDAP compare
operation synchronously. It takes dn, the DN of the entry upon which to
perform the compare, and attr and value, the attribute type and value to
compare to those found in the entry. It returns an LDAP error code,
which will be LDAP_COMPARE_TRUE if the entry contains the attribute
value and LDAP_COMPARE_FALSE if it does not. Otherwise, some error code
is returned.


The ldap_compare() function is used to perform an LDAP compare operation
asynchronously. It takes the same parameters as ldap_compare_s(), but
returns the message id of the request it initiated. The result of the
compare can be obtained by a subsequent call to ldap_result(3LDAP).


The ldap_compare_ext() function initiates an asynchronous compare
operation and returns LDAP_SUCCESS if the request was successfully sent
to the server, or else it returns a LDAP error code if not (see
ldap_error(3LDAP). If successful, ldap_compare_ext() places the message
id of the request in *msgidp. A subsequent call to ldap_result(), can be
used to obtain the result of the add request.


The ldap_compare_ext_s() function initiates a synchronous compare
operation and as such returns the result of the operation itself.

ERRORS

ldap_compare_s() returns an LDAP error code which can be interpreted by
calling one of ldap_perror(3LDAP) and friends. ldap_compare() returns
-1 if something went wrong initiating the request. It returns the non-
negative message id of the request if it was successful.

ATTRIBUTES

See attributes(7) for a description of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|Interface Stability | Evolving |
+--------------------+-----------------+

SEE ALSO

ldap(3LDAP), ldap_error(3LDAP), attributes(7)

BUGS

There is no way to compare binary values using ldap_compare().

January 27, 2002 LDAP_COMPARE(3LDAP)