Netscape DIRECTORY SERVER 6.02 - PLUG-IN Manual page 327

Parameters
This function takes the following parameters:
Space-delimited list of one or more host names (or IP address in
ldaphost
dotted notation, such as "141.211.83.36") of the LDAP servers that
you want to connect to.
The names can be in hostname:portnumber format (in which
case, portnumber overrides the port number specified by the
ldapport argument).
Port number of the LDAP server.
ldapport
Determines whether or not to establish the connection over SSL. Set
secure
this to a non-zero value to establish the connection over SSL.
Determines whether or not the LDAP session (the LDAP structure)
shared
can be shared by different threads. Set this to a non-zero value to
allow multiple threads to share the session.
Returns
This function returns one of the following values:
• If successful, returns a pointer to an
to subsequent calls to other LDAP API functions.
• If unsuccessful, returns
Description
This function initializes an LDAP session with another LDAP server. If you want to
connect to another LDAP server over SSL or if you want to allow multiple threads
to use the same connection, call this function instead of the
provided with the Netscape Directory SDK.
This function allocates an
session, including the host name and port of the LDAP server, preferences for the
session (such as the maximum number of entries to return in a search), and the
error code of the last LDAP operation performed.
You can specify a list of LDAP servers that you want to attempt to connect to. Your
client will attempt to connect to the first LDAP server in the list. If the attempt fails,
your client will attempt to connect to the next LDAP server in the list.
If you specify a non-zero value for the
the plug-in for SSL and installs the I/O routines for SSL.
structure, which should be passed
LDAP
.
NULL
structure containing information about the
LDAP
secure
Functions for Thread-Safe LDAP Connections
ldap_init()
argument, this function initializes
Chapter 14 Function Reference
function
327