usr/src/man/man3ldap/ldap_parse_result.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_PARSE_RESULT 3LDAP "Jan 27, 2002"
   8 .SH NAME
   9 ldap_parse_result, ldap_parse_extended_result, ldap_parse_sasl_bind_result \-
  10 LDAP message result parser
  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_parse_result\fR(\fBLDAP\fR \fI*ld\fR, \fBLDAPMessage\fR \fI*res\fR, \fBint\fR \fI*errcodep\fR,
  19      \fBchar\fR \fI**matcheddnp\fR,\fBchar\fR \fI**errmsgp\fR, \fBchar\fR \fI***referralsp\fR,
  20      \fBLDAPControl\fR \fI***serverctrlsp\fR,\fBint\fR \fIfreeit\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBldap_parse_sasl_bind_result\fR(\fBLDAP\fR \fI*ld\fR, \fBLDAPMessage\fR \fI*res\fR,
  26      \fBstruct berval\fR\fI**servercredp\fR,\fBint\fR \fIfreeit\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBint\fR \fBldap_parse_extended_result\fR(\fBLDAP\fR \fI*ld\fR, \fBLDAPMessage\fR \fI*res\fR,
  32      \fBstruct berval\fR\fBchar\fR \fI**resultoidp\fR, \fI**resultdata\fR, \fBint\fR \fIfreeit\fR);
  33 .fi
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 The \fBldap_parse_extended_result()\fR, \fBldap_parse_result()\fR and
  39 \fBldap_parse_sasl_bind_result()\fR routines search for a message to parse.
  40 These functions skip messages of type  \fBLDAP_RES_SEARCH_ENTRY\fR and
  41 \fBLDAP_RES_SEARCH_REFERENCE\fR.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 They return  \fBLDAP_SUCCESS\fR if the result was successfully parsed  or an
  46 LDAP error code if not (see \fBldap_error\fR(3LDAP)).
  47 .SH ATTRIBUTES
  48 .sp
  49 .LP
  50 See \fBattributes\fR(5) for a description of the following attributes:
  51 .sp
  52
  53 .sp
  54 .TS
  55 box;
  56 c | c
  57 l | l .
  58 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  59 Interface Stability     Evolving
  60 .TE
  61
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBldap_error\fR(3LDAP), \fBldap_result\fR(3LDAP), \fBattributes\fR(5)