MAN page from RedHat Other ldap-devel-3.3-3.i386.rpm

LDAP_OPEN

Section: C Library Functions (3)
Updated: 28 March 1996
Index

NAME

ldap_init, ldap_open - Initialize the LDAP library and open a connection to an LDAP server

SYNOPSIS

#include <lber.h>#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 LDAPstructure which is used to identifythe connection and to maintain per-connection information.ldap_init()allocates an LDAP structure but does not open an initial connection. Oneof these two routines must be called before any operations are attempted.

ldap_open()takes host, the hostname on which the LDAP server isrunning, and port, the port number to which to connect. If the defaultIANA-assigned port of 389 is desired, LDAP_PORT should be specified forport. The host parameter may contain a blank-separated listof hosts to try to connect to, and each host may optionally by of the formhost:port. If present, the :port overrides the portparameter toldap_open().Upon successfully making a connection to anLDAP server,ldap_open()returns a pointer to an LDAP structure (defined below), whichshould be passed to subsequent calls toldap_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 likeldap_open(),but does not open a connectionto the LDAP server. The actual connection open will occur when thefirst operation is attempted. At this time,ldap_init()should onlybe used if the LDAP library is compiled with LDAP_REFERRALS defined.

ERRORS

If an error occurs, these routines will return NULL and errno should beset appropriately.

OPTIONS

Options that affect a particular LDAP instance may be set by modifyingthe ld_options field in the LDAP structure. This field is setto LDAP_OPT_REFERRALS inldap_open() andldap_init(),which causes the library to automatically follow referralsto other servers that may be returned in response to an LDAP operation.

The other supported option is LDAP_OPT_RESTART, which if set willcause the LDAP library to restart theselect(2)system call when it is interrupted by the system (i.e., errno is set toEINTR). This option is not supported on the Macintosh and under MS-DOS.

An option can be turned off by clearing the appropriate bit in theld_options field.

NOTES

There are other elements in the LDAP structure that you should notchange. You should not make any assumptions about the order of elementsin the LDAP structure.

This document was created byman2html,using the manual pages.