upstream/openldap
1
0
Fork 0
mirror of https://git.openldap.org/openldap/openldap.git synced 2025-12-20 22:59:34 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Leave dn2ufn.

Browse source
This commit is contained in:
Kurt Zeilenga 2001-06-11 20:45:06 +00:00
parent 6cb35c0d89
commit 72a55aa40f
2 changed files with 21 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
doc/man/man3/ldap_get_dn.3
View file

@ -3,7 +3,7 @@
.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved. .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE. .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.SH NAME .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 .SH SYNOPSIS
.nf .nf
.ft B .ft B
@ -26,6 +26,11 @@ char **ldap_explode_rdn(rdn, notypes)
.ft .ft
char *rdn; char *rdn;
int notypes; int notypes;
.LP
.ft B
char *ldap_dn2ufn(dn)
.ft
char *dn;
.SH DESCRIPTION .SH DESCRIPTION
These routines allow LDAP entry names (Distinguished Names, or DNs) These routines allow LDAP entry names (Distinguished Names, or DNs)
to be obtained, parsed, converted to a user-friendly form, and tested. 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 if the \fInotypes\fP parameter is set). The result can be freed by
calling calling
.BR ldap_value_free (3). .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 .SH ERRORS
If an error occurs in If an error occurs in
.BR ldap_get_dn() , .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 field in the \fIld\fP parameter is set to indicate the error. See
.BR ldap_error (3) .BR ldap_error (3)
for a description of possible error codes. for a description of possible error codes.
.BR ldap_explode_dn() and .BR ldap_explode_dn() ,
.B ldap_explode_rdn() .BR ldap_explode_rdn() ,
and
.B ldap_dn2ufn()
will return NULL with will return NULL with
.BR errno (3) .BR errno (3)
set appropriately in case of trouble. set appropriately in case of trouble.

1
doc/man/man3/ldap_get_dn.3.links
View file

@ -1,2 +1,3 @@
ldap_explode_dn.3 ldap_explode_dn.3
ldap_explode_rdn.3 ldap_explode_rdn.3
ldap_dn2ufn.3