usr/src/man/man3ldap/cldap_open.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 CLDAP_OPEN 3LDAP "Jan 27, 2002"
   8 .SH NAME
   9 cldap_open \- LDAP connectionless communication preparation
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc[ \fIflag\fR... ] \fIfile\fR... -lldap[ \fIlibrary\fR... ]
  14 #include <lber.h>
  15 #include <ldap.h>
  16
  17 \fBLDAP *\fR\fBcldap_open\fR(\fBchar\fR \fI*host\fR, \fBint\fR \fIport\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIhost\fR\fR
  25 .ad
  26 .RS 8n
  27 The name of the host on which the LDAP server is running.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIport\fR\fR
  34 .ad
  35 .RS 8n
  36 The port number to connect.
  37 .RE
  38
  39 .SH DESCRIPTION
  40 .sp
  41 .LP
  42 The \fBcldap_open()\fR function is called to prepare for connectionless LDAP
  43 communication (over \fBudp\fR(7P)). It allocates an LDAP structure which is
  44 passed to future search requests.
  45 .sp
  46 .LP
  47 If the default IANA-assigned port of 389 is desired,  \fBLDAP_PORT\fR should be
  48 specified for \fIport\fR. \fIhost\fR can contain a space-separated list of
  49 hosts or addresses to try. \fBcldap_open()\fR returns a pointer to an LDAP
  50 structure, which should be passed to subsequent calls to
  51 \fBcldap_search_s\fR(3LDAP), \fBcldap_setretryinfo\fR(3LDAP), and
  52 \fBcldap_close\fR(3LDAP). Certain fields in the LDAP structure can be set to
  53 indicate size limit, time limit, and how aliases are handled during operations.
  54 See \fBldap_open\fR(3LDAP) and  \fB<ldap.h>\fR for more details.
  55 .SH ERRORS
  56 .sp
  57 .LP
  58 If an error occurs, \fBcldap_open()\fR will return  \fINULL\fR and  \fBerrno\fR
  59 will be set appropriately.
  60 .SH ATTRIBUTES
  61 .sp
  62 .LP
  63 See \fBattributes\fR(5) for a description of the following attributes:
  64 .sp
  65
  66 .sp
  67 .TS
  68 box;
  69 c | c
  70 l | l .
  71 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  72 Interface Stability     Evolving
  73 .TE
  74
  75 .SH SEE ALSO
  76 .sp
  77 .LP
  78 \fBldap\fR(3LDAP) \fBcldap_search_s\fR(3LDAP), \fBcldap_setretryinfo\fR(3LDAP),
  79 \fBcldap_close\fR(3LDAP), \fBattributes\fR(5), \fBudp\fR(7P)