ldap_explode_rdn_utf8()--Break a UTF8 codepage Relative Distinguished Name into Its Components

 #include <ldap.h>
 
 char **ldap_explode_rdn_utf8(
                char  *rdn,
                int    notypes)

The ldap_explode_rdn_utf8() function uses the relative distinguished name (RDN) in UTF8 characters (as returned by, ldap_explode_dn_utf8(), for example) and breaks it up into its component parts. If the RDN is in local codepage, use ldap_explode_rdn().

ldap_explode_rdn_utf8() returns a NULL-terminated array of character strings. The notypes parameter is used to request that only the component values be returned, not their types.

For example, the RDN "ou=Research+cn=Bob" would return as either {"ou=Research", "cn=Bob", NULL} or {"Research","Bob", NULL}, depending on whether notypes was 0 or 1, respectively. The result can be freed by calling ldap_value_free().

Authorities and Locks

No IBM^® i authority is required.

Parameters

rdn

(Input) The RDN to be exploded (perhaps as returned by ldap_explode_dn_utf8()). Multiple RDNs can be concatenated using a plus sign ('+').

notypes

(Input) Whether type information is to be returned with each RDN. If non-zero, the type information is stripped. If zero, the type information is retained. For example, setting notypes to 1 would result in the RDN "cn=Fido" being returned as "Fido".

Return Value

Components of Relative Distinguished Name (RDN)

The request was successful.

NULL

The request was not successful. The ldap_get_errno() API can be used to obtain the error code.

Error Conditions

If ldap_explode_rdn_utf8() is not successful, ld_errno will be set to indicate the error. See LDAP Client API Error Conditions for possible LDAP error code values. Use the ldap_get_errno() function to retrieve the error information.

Error Messages

The following message may be sent from this function.

Related Information

• ldap_explode_dn() -- Break a Distinguished Name into Its Components.
• ldap_explode_dn_utf8() -- Break a UTF8 codepage Distinguished Name into Its Components.
• ldap_explode_rdn() -- Break a Distinguished Name into Its Components.

[ Back to top | LDAP APIs | APIs by category ]