usr/src/man/man3ldap/ldap_compare.3ldap

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH LDAP_COMPARE 3LDAP "Jan 27, 2002"
   8 .SH NAME
   9 ldap_compare, ldap_compare_s, ldap_compare_ext, ldap_compare_ext_s \- LDAP
  10 compare operation
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc[ \fIflag\fR... ] \fIfile\fR... -lldap[ \fIlibrary\fR... ]
  15 #include <lber.h>
  16 #include <ldap.h>
  17
  18 \fBint\fR \fBldap_compare\fR(\fBLDAP\fR \fI*ld\fR, \fBchar\fR \fI*dn\fR, \fBchar\fR \fI*attr\fR, \fBchar\fR \fI*value\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBldap_compare_s\fR(\fBLDAP\fR \fI*ld\fR, \fBchar\fR \fI*dn\fR, \fBchar\fR \fI*attr\fR, \fBchar\fR \fI*value\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBldap_compare_ext\fR(\fBLDAP\fR \fI*ld\fR, \fBchar\fR \fI*dn\fR, \fBchar\fR \fI*attr\fR,
  29      \fBstruct berval\fR \fI*bvalue\fR, \fBLDAPControl\fR \fI**serverctrls\fR,
  30      \fBLDAPControl\fR \fI**clientctrls\fR,\fBint\fR \fI*msgidp\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBldap_compare_ext_s\fR(\fBLDAP\fR \fI*ld\fR, \fBchar\fR \fI*dn\fR, \fBchar\fR \fI*attr\fR,
  36      \fBstruct berval\fR \fI*bvalue\fR, \fBLDAPControl\fR \fI**serverctrls\fR,
  37      \fBLDAPControl\fR \fI**clientctrls\fR);
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBldap_compare_s()\fR function is used to perform an LDAP compare
  44 operation synchronously.  It takes \fIdn\fR, the DN of the entry upon which to
  45 perform the compare, and \fIattr\fR and \fIvalue\fR, the attribute type and
  46 value to compare to those found in the entry.  It returns an LDAP error code,
  47 which will be  \fBLDAP_COMPARE_TRUE\fR if the entry contains the attribute
  48 value and \fBLDAP_COMPARE_FALSE\fR if it does not.  Otherwise, some error code
  49 is returned.
  50 .sp
  51 .LP
  52 The \fBldap_compare()\fR function is used to perform an LDAP compare operation
  53 asynchronously.  It takes the same parameters as \fBldap_compare_s()\fR, but
  54 returns the message id of the request it initiated.  The result of the compare
  55 can be obtained by a subsequent call to \fBldap_result\fR(3LDAP).
  56 .sp
  57 .LP
  58 The  \fBldap_compare_ext()\fR function initiates an asynchronous compare
  59 operation and returns  \fBLDAP_SUCCESS\fR if the request was successfully sent
  60 to the server, or else it returns a LDAP error code if not (see
  61 \fBldap_error\fR(3LDAP). If successful,  \fBldap_compare_ext()\fR places the
  62 message id of the request in  \fI*msgidp\fR. A subsequent call to
  63 \fBldap_result()\fR, can be used to obtain the result of the add request.
  64 .sp
  65 .LP
  66 The  \fBldap_compare_ext_s()\fR function initiates a synchronous compare
  67 operation and as such returns the result of the operation itself.
  68 .SH ERRORS
  69 .sp
  70 .LP
  71 \fBldap_compare_s()\fR returns an LDAP error code which can be interpreted by
  72 calling one of \fBldap_perror\fR(3LDAP) and friends.   \fBldap_compare()\fR
  73 returns \fB\(mi1\fR if something went wrong initiating the request.  It returns
  74 the non-negative message id of the request if it was successful.
  75 .SH ATTRIBUTES
  76 .sp
  77 .LP
  78 See \fBattributes\fR(5) for a description of the following attributes:
  79 .sp
  80
  81 .sp
  82 .TS
  83 box;
  84 c | c
  85 l | l .
  86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  87 Interface Stability     Evolving
  88 .TE
  89
  90 .SH SEE ALSO
  91 .sp
  92 .LP
  93 \fBldap\fR(3LDAP), \fBldap_error\fR(3LDAP), \fBattributes\fR(5)
  94 .SH BUGS
  95 .sp
  96 .LP
  97 There is no way to compare binary values using \fBldap_compare()\fR.