1 .TH LDAP_GET_DN 3 "16 June 1995" "U-M LDAP LDVERSION"
3 ldap_get_dn, ldap_explode_dn, ldap_dn2ufn, ldap_is_dns_dn, ldap_explode_dns \- LDAP DN handling routines
11 char *ldap_get_dn(ld, entry)
17 char **ldap_explode_dn(dn, notypes)
28 int ldap_is_dns_dn(dn)
33 char **ldap_explode_dns(dn)
37 These routines allow LDAP entry names (Distinguished Names, or DNs)
38 to be obtained, parsed, converted to a user-friendly form, and tested.
39 A DN has the form described in RFC 1779 "A String Representation of
40 Distinguished Names", unless it is an experimental DNS-style DN
41 which takes the form of an RFC 822 mail address.
45 routine takes an \fIentry\fP as returned by
46 .BR ldap_first_entry (3)
48 .BR ldap_next_entry (3)
50 the entry's DN. Space for the DN will have been obtained via
52 and should be freed by the caller by a call to
57 routine takes a DN as returned by
59 and breaks it up into its component parts. Each part is known as a
60 Relative Distinguished Name, or RDN.
63 NULL-terminated array, each component of which contains an RDN from the
64 DN. The \fInotypes\fP parameter is used to request that only the RDN
65 values be returned, not their types. For example, the DN "cn=Bob,
66 c=US" would return as either { "cn=Bob", "c=US", NULL } or { "Bob",
67 "US", NULL }, depending on whether notypes was 0 or 1, respectively.
68 The result can be freed by calling
69 .BR ldap_value_free (3).
72 is used to turn a DN as returned by
74 into a more user-friendly form, stripping off type names. See
75 RFC 1781 "Using the Directory to Achieve User Friendly Naming"
76 for more details on the UFN format. The space for the UFN returned
77 is obtained by a call to
79 and the user is responsible for freeing it via a call to
83 returns non-zero if the dn string is an experimental
84 DNS-style DN (generally in the form of an RFC 822 e-mail address). It
85 returns zero if the dn appears to be an RFC 1779 format DN.
88 takes a DNS-style DN and breaks it up into its
91 returns a NULL-terminated array.
92 For example, the DN "mcs.umich.edu" will return { "mcs", "umich", "edu",
93 NULL }. The result can be freed by calling
94 .BR ldap_value_free (3).
98 NULL is returned and the
100 field in the \fIld\fP parameter is set to indicate the error. See
102 for a description of possible error codes.
103 .BR ldap_explode_dn() ,
104 .B ldap_explode_dns()
107 will return NULL with
109 set appropriately in case of trouble.
111 These routines malloc memory that the caller must free.
114 .BR ldap_first_entry(3),
116 .BR ldap_value_free(3)