1 .TH LDAP_GET_DN 3 "22 September 1998" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldap_get_dn, ldap_explode_dn, ldap_explode_rdn, ldap_dn2ufn, ldap_is_dns_dn, ldap_explode_dns \- LDAP DN handling routines
13 char *ldap_get_dn(ld, entry)
19 char **ldap_explode_dn(dn, notypes)
25 char **ldap_explode_rdn(rdn, notypes)
36 int ldap_is_dns_dn(dn)
41 char **ldap_explode_dns(dn)
45 These routines allow LDAP entry names (Distinguished Names, or DNs)
46 to be obtained, parsed, converted to a user-friendly form, and tested.
47 A DN has the form described in RFC 1779 "A String Representation of
48 Distinguished Names", unless it is an experimental DNS-style DN
49 which takes the form of an RFC 822 mail address.
53 routine takes an \fIentry\fP as returned by
54 .BR ldap_first_entry (3)
56 .BR ldap_next_entry (3)
58 the entry's DN. Space for the DN will be obtained dynamically
59 and should be freed by the caller using
64 routine takes a DN as returned by
66 and breaks it up into its component parts. Each part is known as a
67 Relative Distinguished Name, or RDN.
70 NULL-terminated array, each component of which contains an RDN from the
71 DN. The \fInotypes\fP parameter is used to request that only the RDN
72 values be returned, not their types. For example, the DN "cn=Bob,
73 c=US" would return as either { "cn=Bob", "c=US", NULL } or { "Bob",
74 "US", NULL }, depending on whether notypes was 0 or 1, respectively.
75 The result can be freed by calling
76 .BR ldap_value_free (3).
80 routine takes an RDN as returned by
81 .B ldap_explode_dn(dn,0)
82 and breaks it up into its "type=value" component parts (or just "value",
83 if the \fInotypes\fP parameter is set). The result can be freed by
85 .BR ldap_value_free (3).
88 is used to turn a DN as returned by
90 into a more user-friendly form, stripping off type names. See
91 RFC 1781 "Using the Directory to Achieve User Friendly Naming"
92 for more details on the UFN format. The space for the UFN returned
93 is obtained dynamically and the user is responsible for freeing it
98 returns non-zero if the dn string is an experimental
99 DNS-style DN (generally in the form of an RFC 822 e-mail address). It
100 returns zero if the dn appears to be an RFC 1779 format DN.
102 .B ldap_explode_dns()
103 takes a DNS-style DN and breaks it up into its
105 .B ldap_explode_dns()
106 returns a NULL-terminated array.
107 For example, the DN "mcs.umich.edu" will return { "mcs", "umich", "edu",
108 NULL }. The result can be freed by calling
109 .BR ldap_value_free (3).
111 If an error occurs in
113 NULL is returned and the
115 field in the \fIld\fP parameter is set to indicate the error. See
117 for a description of possible error codes.
118 .BR ldap_explode_dn() ,
119 .BR ldap_explode_rdn() ,
120 .B ldap_explode_dns()
123 will return NULL with
125 set appropriately in case of trouble.
127 These routines dyanamically allocate memory that the caller must free.
131 .BR ldap_first_entry(3),
133 .BR ldap_value_free(3)
136 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
138 is derived from University of Michigan LDAP 3.3 Release.