.\" 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
.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() 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.