Merge remote-tracking branch 'origin/mdb.master'

[openldap] / doc / man / man3 / ldap_get_dn.3

diff --git a/doc/man/man3/ldap_get_dn.3 b/doc/man/man3/ldap_get_dn.3
index cccdf0cdd002965047de105b32457c1f22950ffe..85aa0b49f03bedbdb0eb1febbc9dfa65a9db1a07 100644 (file)
--- a/doc/man/man3/ldap_get_dn.3
+++ b/doc/man/man3/ldap_get_dn.3
@@ -1,11 +1,11 @@
 .TH LDAP_GET_DN 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2012 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
 .SH LIBRARY
-OpenLDAP LDAP (libldap, -lldap)
+OpenLDAP LDAP (libldap, \-lldap)
 .SH SYNOPSIS
 .nf
 .ft B
@@ -15,10 +15,13 @@ OpenLDAP LDAP (libldap, -lldap)
 char *ldap_get_dn( LDAP *ld, LDAPMessage *entry )
 .LP
 .ft B
-int ldap_str2dn( const char *str, LDAPDN **dn, unsigned flags )
+int ldap_str2dn( const char *str, LDAPDN *dn, unsigned flags )
 .LP
 .ft B
-int ldap_dn2str( LDAPDN *dn, char **str, unsigned flags )
+void ldap_dnfree( LDAPDN dn )
+.LP
+.ft B
+int ldap_dn2str( LDAPDN dn, char **str, unsigned flags )
 .LP
 .ft B
 char **ldap_explode_dn( const char *dn, int notypes )
@@ -68,7 +71,13 @@ structures, arranged in
 .B LDAPRDN,
 and 
 .B LDAPDN
-terms, defined as:
+terms.  Space for
+.B dn
+will be obtained dynamically and should be freed by the caller using
+.BR ldap_dnfree (3).
+The
+.B LDAPDN
+is defined as:
 .nf
 .ft B
 
@@ -79,7 +88,7 @@ typedef struct ldap_ava {
 } LDAPAVA;
 
 typedef LDAPAVA** LDAPRDN;
-typedef LDAPRDN** LDAPDN;
+typedef LDAPRDN* LDAPDN;
 
 .ft
 .fi