xref: /illumos-gate/usr/src/man/man3ldap/cldap_open.3ldap (revision 5d9d9091f564c198a760790b0bfa72c44e17912b)
te
Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
CLDAP_OPEN 3LDAP "Jan 27, 2002"
NAME
cldap_open - LDAP connectionless communication preparation
SYNOPSIS

cc[ flag... ] file... -lldap[ library... ]
#include <lber.h>
#include <ldap.h>

LDAP *cldap_open(char *host, int port);
PARAMETERS
host

The name of the host on which the LDAP server is running.

port

The port number to connect.

DESCRIPTION

The cldap_open() function is called to prepare for connectionless LDAP communication (over udp(4P)). It allocates an LDAP structure which is passed to future search requests.

If the default IANA-assigned port of 389 is desired, LDAP_PORT should be specified for port. host can contain a space-separated list of hosts or addresses to try. cldap_open() returns a pointer to an LDAP structure, which should be passed to subsequent calls to cldap_search_s(3LDAP), cldap_setretryinfo(3LDAP), and cldap_close(3LDAP). Certain fields in the LDAP structure can be set to indicate size limit, time limit, and how aliases are handled during operations. See ldap_open(3LDAP) and <ldap.h> for more details.

ERRORS

If an error occurs, cldap_open() will return NULL and errno will be set appropriately.

ATTRIBUTES

See attributes(7) for a description of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
SEE ALSO

ldap(3LDAP) cldap_close(3LDAP), cldap_search_s (3LDAP), cldap_setretryinfo (3LDAP), udp (4P), attributes (7)