routines can be used test a URL to see if it is an LDAP URL, to parse LDAP
URLs into their component pieces, and to initiate searches directly using
an LDAP URL.
-.SH USER FRIENDLY NAMING
-The
-.BR ldap_ufn (3)
-routines implement a user friendly naming
-scheme via LDAP. This scheme allows you to look up entries
-using fuzzy, untyped names like "john smith, example corp, ca, us".
.SH CACHING
The
.BR ldap_cache (3)
.SM ldap_explode_rdn(3)
convert a RDN into its component parts
.TP
-.SM ldap_dn2ufn(3)
-convert a DN into user friendly form
-.TP
.SM ldap_get_values(3)
return an attribute's values
.TP
.SM ldap_search_st(3)
synchronously search the directory with timeout
.TP
-.SM ldap_ufn_search_s(3)
-user friendly search the directory
-.TP
-.SM ldap_ufn_search_c(3)
-user friendly search the directory with cancel
-.TP
-.SM ldap_ufn_search_ct(3)
-user friendly search the directory with cancel and timeout
-.TP
-.SM ldap_ufn_setfilter(3)
-set filter file used by ldap_ufn(3) routines
-.TP
-.SM ldap_ufn_setprefix(3)
-set prefix used by ldap_ufn(3) routines
-.TP
-.SM ldap_ufn_timeout(3)
-set timeout used by ldap_ufn(3) routines
-.TP
.SM ldap_is_ldap_url(3)
check a URL string to see if it is an LDAP URL
.TP
.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.SH NAME
-ldap_get_dn, ldap_explode_dn, ldap_explode_rdn, ldap_dn2ufn \- LDAP DN handling routines
+ldap_get_dn, ldap_explode_dn, ldap_explode_rdn \- LDAP DN handling routines
.SH SYNOPSIS
.nf
.ft B
.ft
char *rdn;
int notypes;
-.LP
-.ft B
-char *ldap_dn2ufn(dn)
-.ft
-char *dn;
.SH DESCRIPTION
These routines allow LDAP entry names (Distinguished Names, or DNs)
to be obtained, parsed, converted to a user-friendly form, and tested.
if the \fInotypes\fP parameter is set). The result can be freed by
calling
.BR ldap_value_free (3).
-.LP
-.B ldap_dn2ufn()
-is used to turn a DN as returned by
-.B ldap_get_dn()
-into a more user-friendly form, stripping off type names. See
-RFC 1781 "Using the Directory to Achieve User Friendly Naming"
-for more details on the UFN format. The space for the UFN returned
-is obtained dynamically and the user is responsible for freeing it
-via a call to
-.BR ldap_memfree (3).
.SH ERRORS
If an error occurs in
.BR ldap_get_dn() ,
field in the \fIld\fP parameter is set to indicate the error. See
.BR ldap_error (3)
for a description of possible error codes.
-.BR ldap_explode_dn() ,
-.BR ldap_explode_rdn() ,
-and
-.B ldap_dn2ufn()
+.BR ldap_explode_dn() and
+.B ldap_explode_rdn()
will return NULL with
.BR errno (3)
set appropriately in case of trouble.
+++ /dev/null
-.TH LDAP_UFN 3 "22 September 1998" "OpenLDAP LDVERSION"
-.\" $OpenLDAP$
-.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
-.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
-.SH NAME
-ldap_ufn_search_s, ldap_ufn_search_c, ldap_ufn_search_ct, ldap_ufn_setfilter, ldap_ufn_setfilter, ldap_ufn_setprefix, ldap_ufn_timeout \- Perform an LDAP user friendly search operation
-.SH SYNOPSIS
-.nf
-.ft B
-#include <ldap.h>
-.LP
-.ft B
-int ldap_ufn_search_c(ld, ufn, attrs, attrsonly, res, cancelproc,
- cancelparm)
-.ft
-LDAP *ld;
-char *ufn;
-char **attrs;
-int attrsonly;
-LDAPMessage **res;
-int (*cancelproc)();
-void *cancelparm;
-.LP
-.ft B
-int ldap_ufn_search_ct(ld, ufn, attrs, attrsonly, res, cancelproc,
- cancelparm, tag1, tag2, tag3)
-.ft
-LDAP *ld;
-char *ufn;
-char **attrs;
-int attrsonly;
-LDAPMessage **res;
-int (*cancelproc)();
-void *cancelparm;
-char *tag1, *tag2, *tag3;
-.LP
-.ft B
-int ldap_ufn_search_s(ld, ufn, attrs, attrsonly, res)
-.ft
-LDAP *ld;
-char *ufn;
-char **attrs;
-int attrsonly;
-LDAPMessage **res;
-.LP
-.ft B
-LDAPFiltDesc *ldap_ufn_setfilter(ld, fname)
-.ft
-LDAP *ld;
-char *fname;
-.LP
-.ft B
-void ldap_ufn_setprefix(ld, prefix)
-.ft
-LDAP *ld;
-char *prefix;
-.LP
-.ft B
-int ldap_ufn_timeout(tvparam)
-.ft
-void *tvparam;
-.SH DESCRIPTION
-These routines are used to perform LDAP user friendly search operations.
-.B ldap_ufn_search_s()
-is the simplest form. It does the search
-synchronously. It takes \fIld\fP to identify the the LDAP connection.
-The \fIufn\fP parameter is the user friendly name for which to search.
-The \fIattrs\fP, \fIattrsonly\fP and \fIres\fP parameters are the
-same as for
-.BR ldap_search (3).
-.LP
-The
-.B ldap_ufn_search_c()
-routine functions the same as
-.BR ldap_ufn_search_s() ,
-except that it takes \fIcancelproc\fP, a function to call periodicly
-during the search. It should be a function taking a single void *
-argument, given by \fIcalcelparm\fP. If \fIcancelproc\fP returns a
-non-zero result, the search will be abandoned and no results returned.
-The purpose of this routine is to provide a way for the search to be
-cancelled, for example, by a user or because some other condition
-occurs.
-.LP
-The
-.B ldap_ufn_search_ct()
-routine is like
-.BR ldap_ufn_search_c() ,
-except that it takes three extra parameters. \fItag1\fP is passed to the
-.BR ldap_init_getfilter (3)
-routine when resolving the first component of
-the UFN. \fItag2\fP is used when resolving intermediate components.
-\fItag3\fP is used when resolving the last component. By default,
-the tags used by the other UFN search routines during these three
-phases of the search are "ufn first", "ufn intermediate", and "ufn last".
-.LP
-The
-.B ldap_ufn_setfilter()
-routine is used to set the
-.BR ldapfilter.conf (5)
-file for use with the
-.BR ldap_init_getfilter (3)
-routine to \fIfname\fP.
-.LP
-The
-.B ldap_ufn_setprefix()
-routine is used to set the default prefix
-(actually, it's a suffix) appended to UFNs before searhing. UFNs
-with fewer than three components have the prefix appended first,
-before searching. If that fails, the UFN is tried with progressively
-shorter versions of the prefix, stripping off components. If the UFN
-has three or more components, it is tried by itself first. If that
-fails, a similar process is applied with the prefix appended.
-.LP
-The
-.B ldap_ufn_timeout()
-routine is used to set the timeout associated
-with
-.B ldap_ufn_search_s()
-searches. The \fItimeout\fP parameter
-should actually be a pointer to a struct timeval (this is so
-.B ldap_ufn_timeout()
-can be used as a cancelproc in the above routines).
-.SH NOTES
-These routines may dynamically allocate memory. The caller is
-required to free such memory using the supplied deallocation routines.
-Return values are contained
-in <ldap.h>.
-.SH SEE ALSO
-.BR gettimeofday (2),
-.BR ldap (3),
-.BR ldap_search (3),
-.BR ldap_getfilter (3),
-.BR ldapfilter.conf (5),
-.BR ldap_error (3)
-.SH ACKNOWLEDGEMENTS
-.B OpenLDAP
-is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B OpenLDAP
-is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / commitdiff