usr/src/man/man3ldap/ldap_first_message.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_FIRST_MESSAGE 3LDAP "Jan 27, 2002"
   8 .SH NAME
   9 ldap_first_message, ldap_count_messages, ldap_next_message, ldap_msgtype \-
  10 LDAP message processing functions
  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_count_messages\fR(\fBLDAP\fR \fI*ld\fR, \fBLDAPMessage\fR \fI*res\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBLDAPMessage *\fR\fBldap_first_message\fR(\fBLDAP\fR \fI*ld\fR, \fBLDAPMessage\fR \fI*res\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBLDAPMessage *\fR\fBldap_next_message\fR(\fBLDAP\fR \fI*ld\fR, \fBLDAPMessage\fR \fI*msg\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBint\fR \fBldap_msgtype\fR(\fBLDAPMessage\fR \fI*res\fR);
  34 .fi
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 \fBldap_count_messages()\fR is used to count the number of messages that remain
  40 in a chain of results if called with a  message, entry, or reference returned
  41 by  \fBldap_first_message()\fR, \fBldap_next_message()\fR,
  42 \fBldap_first_entry()\fR, \fBldap_next_entry()\fR,
  43 \fBldap_first_reference()\fR, and  \fBldap_next_reference()\fR
  44 .sp
  45 .LP
  46 \fBldap_first_message()\fR and   \fBldap_next_message()\fR functions are used
  47 to step through the list of messages in a result chain returned by
  48 \fBldap_result()\fR.
  49 .sp
  50 .LP
  51 \fBldap_msgtype()\fR function returns the type of an LDAP message.
  52 .SH RETURN VALUES
  53 .sp
  54 .LP
  55 \fBldap_first_message()\fR and  \fBldap_next_message()\fR return
  56 \fBLDAPMessage\fR which can include referral messages, entry messages and
  57 result messages.
  58 .sp
  59 .LP
  60 \fBldap_count_messages()\fR returns the number of messages contained in a chain
  61 of results.
  62 .SH ERRORS
  63 .sp
  64 .LP
  65 \fBldap_first_message()\fR and  \fBldap_next_message()\fR return  \fINULL\fR
  66 when no more messages exist.  \fINULL\fR is also returned if an error occurs
  67 while  stepping through the entries, in which case the error parameters in the
  68 session handle  \fIld\fR will be set to indicate the error.
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for a description of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 Interface Stability     Evolving
  82 .TE
  83
  84 .SH SEE ALSO
  85 .sp
  86 .LP
  87 \fBldap_error\fR(3LDAP), \fBldap_result\fR(3LDAP), \fBattributes\fR(5)