ldap_init(3ldap) [opensolaris man page]
ldap_open(3LDAP) LDAP Library Functions ldap_open(3LDAP) NAME
ldap_open, ldap_init - initialize an LDAP session SYNOPSIS
cc [ flag... ] file... -lldap [ library... ] #include <lber.h> #include <ldap.h> LDAP *ldap_open(const char *host, int port); LDAP *ldap_init(const char *host, int port); DESCRIPTION
The ldap_open() function initializes an LDAP session and also opens a connection to an LDAP server before it returns to the caller. Unlike ldap_open(), ldap_init() does not open a connection to the LDAP server until an operation, such as a search request, is performed. The ldap_open() function is deprecated and should no longer be used. Call ldap_init() instead. A list of LDAP hostnames or an IPv4 or IPv6 address can be specified with the ldap_open() and ldap_init() functions. The hostname can include a port number, separated from the hostname by a colon (:). A port number included as part of the hostname takes precedence over the port parameter. The ldap_open() and ldap_init() functions attempt connections with LDAP hosts in the order listed and return the first suc- cessful connection. PARAMETERS
These functions support the following parameters. host The hostname, IPv4 or IPv6 address of the host that runs the LDAP server. A space-separated list of hostnames can also be used for this parameter. port TCP port number of a connection. Supply the constant LDAP_PORT to obtain the default LDAP port of 389. If a host includes a port number, the default parameter is ignored. RETURN VALUES
The ldap_open() and ldap_init() functions return a handle to an LDAP session that contains a pointer to an opaque structure. The structure must be passed to subsequent calls for the session. If a session cannot be initialized, the functions return NULL and errno should be set appropriately. Various aspects of this opaque structure can be read or written to control the session-wide parameters. Use the ldap_get_option(3LDAP) to access the current option values and the ldap_set_option(3LDAP) to set values for these options. EXAMPLES
Example 1 Specifying IPv4 and IPv6 Addresses LDAP sessions can be initialized with hostnames, IPv4 or IPv6 addresses, such as those shown in the following examples. ldap_init("hosta:636 hostb", 389) ldap_init("192.168.82.110:389", 389) ldap_init("[fec0::114:a00:20ff:ab3d:83ed]", 389) ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Evolving | +-----------------------------+-----------------------------+ |MT-Level |Safe | +-----------------------------+-----------------------------+ SEE ALSO
errno(3C), ldap(3LDAP), ldap_bind(3LDAP), ldap_get_option(3LDAP), ldap_set_option(3LDAP), attributes(5) SunOS 5.11 15 Jan 2004 ldap_open(3LDAP)
Check Out this Related Man Page
LDAP_OPEN(3) Library Functions Manual LDAP_OPEN(3) NAME
ldap_init, ldap_open - Initialize the LDAP library and open a connection to an LDAP server LIBRARY
OpenLDAP LDAP (libldap, -lldap) SYNOPSIS
#include <ldap.h> LDAP *ldap_open(host, port) char *host; int port; LDAP *ldap_init(host, port) char *host; int port; DESCRIPTION
ldap_open() opens a connection to an LDAP server and allocates an LDAP structure which is used to identify the connection and to maintain per-connection information. ldap_init() allocates an LDAP structure but does not open an initial connection. One of these two routines must be called before any operations are attempted. ldap_open() takes host, the hostname on which the LDAP server is running, and port, the port number to which to connect. If the default IANA-assigned port of 389 is desired, LDAP_PORT should be specified for port. The host parameter may contain a blank-separated list of hosts to try to connect to, and each host may optionally by of the form host:port. If present, the :port overrides the port parameter to ldap_open(). Upon successfully making a connection to an LDAP server, ldap_open() returns a pointer to an LDAP structure (defined below), which should be passed to subsequent calls to ldap_bind(), ldap_search(), etc. Certain fields in the LDAP structure can be set to indicate size limit, time limit, and how aliases are handled during operations. See <ldap.h> for more details. typedef struct ldap { /* ... other stuff you should not mess with ... */ char ld_lberoptions; int ld_deref; #define LDAP_DEREF_NEVER 0 #define LDAP_DEREF_SEARCHING 1 #define LDAP_DEREF_FINDING 2 #define LDAP_DEREF_ALWAYS 3 int ld_timelimit; int ld_sizelimit; #define LDAP_NO_LIMIT 0 int ld_errno; char *ld_error; char *ld_matched; int ld_refhoplimit; unsigned long ld_options; #define LDAP_OPT_REFERRALS 0x00000002 /* set by default */ #define LDAP_OPT_RESTART 0x00000004 /* ... other stuff you should not mess with ... */ } LDAP; ldap_init() acts just like ldap_open(), but does not open a connection to the LDAP server. The actual connection open will occur when the first operation is attempted. At this time, ldap_init() is preferred. ldap_open() will be depreciated in a later release. ERRORS
If an error occurs, these routines will return NULL and errno should be set appropriately. OPTIONS
Options that affect a particular LDAP instance may be set by modifying the ld_options field in the LDAP structure. This field is set to LDAP_OPT_REFERRALS in ldap_open() and ldap_init(), which causes the library to automatically follow referrals to other servers that may be returned in response to an LDAP operation. The other supported option is LDAP_OPT_RESTART, which if set will cause the LDAP library to restart the select(2) system call when it is interrupted by the system (i.e., errno is set to EINTR). This option is not supported on the Macintosh and under MS-DOS. An option can be turned off by clearing the appropriate bit in the ld_options field. NOTES
There are other elements in the LDAP structure that you should not change. You should not make any assumptions about the order of elements in the LDAP structure. SEE ALSO
ldap(3), ldap_bind(3), errno(3) ACKNOWLEDGEMENTS
OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). OpenLDAP is derived from University of Michigan LDAP 3.3 Release. OpenLDAP 2.1.X RELEASEDATE LDAP_OPEN(3)