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

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