git.sur5r.net Git - openldap/blob - doc/man/man3/cldap_open.3

   1 .TH CLDAP_OPEN 3  "18 November 1994" "U-M LDAP LDVERSION"
   2 .SH NAME
   3 cldap_open \- Prepare for Connectionless LDAP Communication
   4 .SH SYNOPSIS
   5 .nf
   6 .ft B
   7 #include <lber.h>
   8 #include <ldap.h>
   9 .LP
  10 .ft B
  11 LDAP *cldap_open(host, port)
  12 .ft
  13 char *host;
  14 int port;
  15 .SH DESCRIPTION
  16 .LP
  17 The
  18 .B cldap_open()
  19 routine is called to prepare for connectionless LDAP
  20 communication (over
  21 .BR udp (4p)).
  22 It allocates an LDAP structure which
  23 is passed to future search requests.
  24 .LP
  25 .B cldap_open()
  26 takes
  27 \fIhost\fP, the nane of the host on which the LDAP server is running, and
  28 \fIport\fP, the port number to which to connect.  If the default
  29 IANA-assigned port of 389 is desired, LDAP_PORT should be specified for
  30 \fIport\fP.  \fIhost\fP can contain a space-separated list of hosts or
  31 addresses to try.
  32 .B cldap_open()
  33 returns a pointer to an LDAP structure, which should be
  34 passed to subsequent calls to
  35 .BR cldap_search_s (3),
  36 .BR cldap_setretryinfo (3),
  37 and
  38 .BR cldap_close (3).
  39 Certain fields in the LDAP structure can be set to
  40 indicate size limit, time limit, and how aliases are handled during
  41 operations.  See
  42 .BR ldap_open (3)
  43 and <ldap.h> for more details.
  44 .SH ERRORS
  45 If an error occurs,
  46 .B cldap_open()
  47 will return NULL and errno will be set appropriately.
  48 .SH SEE ALSO
  49 .BR ldap (3)
  50 .BR cldap_search_s (3),
  51 .BR cldap_setretryinfo (3),
  52 .BR cldap_close (3),
  53 .BR udp (4p)