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

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2004, 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_OPEN 3LDAP "Jan 15, 2004"
   8 .SH NAME
   9 ldap_open, ldap_init \- initialize an LDAP session
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... -lldap [ \fIlibrary\fR... ]
  14 #include <lber.h>
  15 #include <ldap.h>
  16
  17 \fBLDAP *\fR\fBldap_open\fR(\fBconst char *\fR\fIhost\fR, \fBint\fR \fIport\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBLDAP *\fR\fBldap_init\fR(\fBconst char *\fR\fIhost\fR, \fBint\fR \fIport\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBldap_open()\fR function initializes an LDAP session and also opens a
  29 connection to an LDAP server before it returns to the caller. Unlike
  30 \fBldap_open()\fR, \fBldap_init()\fR does not open a connection to the LDAP
  31 server until an operation, such as a search request, is performed.
  32 .sp
  33 .LP
  34 The \fBldap_open()\fR function is deprecated and should no longer be used. Call
  35 \fBldap_init()\fR instead.
  36 .sp
  37 .LP
  38 A list of LDAP hostnames or an IPv4 or IPv6 address can be specified with the
  39 \fBldap_open()\fR and \fBldap_init()\fR functions. The hostname can include a
  40 port number, separated from the hostname by a colon (\fB:\fR). A port number
  41 included as part of the hostname takes precedence over the \fIport\fR
  42 parameter. The \fBldap_open()\fR and \fBldap_init()\fR functions attempt
  43 connections with LDAP hosts in the order listed and return the first successful
  44 connection.
  45 .SH PARAMETERS
  46 .sp
  47 .LP
  48 These functions support the following parameters.
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fIhost\fR\fR
  53 .ad
  54 .RS 8n
  55 The hostname, IPv4 or IPv6 address of the host that runs the LDAP server. A
  56 space-separated list of hostnames can also be used for this parameter.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIport\fR\fR
  63 .ad
  64 .RS 8n
  65 TCP port number of a connection. Supply the constant \fBLDAP_PORT\fR to obtain
  66 the default LDAP port of 389. If a host includes a port number, the default
  67 parameter is ignored.
  68 .RE
  69
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 The \fBldap_open()\fR and \fBldap_init()\fR functions return a handle to an
  74 LDAP session that contains a pointer to an opaque structure. The structure must
  75 be passed to subsequent calls for the session. If a session cannot be
  76 initialized, the functions return \fINULL\fR and \fBerrno\fR should be set
  77 appropriately.
  78 .sp
  79 .LP
  80 Various aspects of this opaque structure can be read or written to control the
  81 session-wide parameters. Use the \fBldap_get_option\fR(3LDAP) to access the
  82 current option values and the \fBldap_set_option\fR(3LDAP) to set values for
  83 these options.
  84 .SH EXAMPLES
  85 .LP
  86 \fBExample 1 \fRSpecifying IPv4 and IPv6 Addresses
  87 .sp
  88 .LP
  89 LDAP sessions can be initialized with hostnames, IPv4 or IPv6 addresses, such
  90 as those shown in the following examples.
  91
  92 .sp
  93 .in +2
  94 .nf
  95 ldap_init("hosta:636 hostb", 389)
  96 ldap_init("192.168.82.110:389", 389)
  97 ldap_init("[fec0::114:a00:20ff:ab3d:83ed]", 389)
  98 .fi
  99 .in -2
 100 .sp
 101
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Evolving
 116 _
 117 MT-Level        Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBerrno\fR(3C), \fBldap\fR(3LDAP), \fBldap_bind\fR(3LDAP),
 124 \fBldap_get_option\fR(3LDAP), \fBldap_set_option\fR(3LDAP), \fBattributes\fR(5)