From: Kurt Zeilenga <kurt@openldap.org>
Date: Mon, 11 Jun 2001 20:45:06 +0000 (+0000)
Subject: Leave dn2ufn.
X-Git-Tag: LDBM_PRE_GIANT_RWLOCK~1326
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=72a55aa40f36a032e494794a31aec329bbbef971;p=openldap

Leave dn2ufn.
---

diff --git a/doc/man/man3/ldap_get_dn.3 b/doc/man/man3/ldap_get_dn.3
index 3035e5ca5d..c1e0401e4f 100644
--- a/doc/man/man3/ldap_get_dn.3
+++ b/doc/man/man3/ldap_get_dn.3
@@ -3,7 +3,7 @@
 .\" 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 DN handling routines
+ldap_get_dn, ldap_explode_dn, ldap_explode_rdn, ldap_dn2ufn \- LDAP DN handling routines
 .SH SYNOPSIS
 .nf
 .ft B
@@ -26,6 +26,11 @@ char **ldap_explode_rdn(rdn, notypes)
 .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.
@@ -68,6 +73,16 @@ and breaks it up into its "type=value" component parts (or just "value",
 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() ,
@@ -76,8 +91,10 @@ NULL is returned and the
 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() and
-.B ldap_explode_rdn()
+.BR ldap_explode_dn() ,
+.BR ldap_explode_rdn() ,
+and
+.B ldap_dn2ufn()
 will return NULL with
 .BR errno (3)
 set appropriately in case of trouble.
diff --git a/doc/man/man3/ldap_get_dn.3.links b/doc/man/man3/ldap_get_dn.3.links
index d67e87dd2c..fe88d238cf 100644
--- a/doc/man/man3/ldap_get_dn.3.links
+++ b/doc/man/man3/ldap_get_dn.3.links
@@ -1,2 +1,3 @@
 ldap_explode_dn.3
 ldap_explode_rdn.3
+ldap_dn2ufn.3