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

Syntax

 #include <ldap.h>
 
 char **ldap_explode_dn_utf8(
                char  *dn,
                int    notypes)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_explode_dn_utf8() function uses the distinguished name in UTF8 characters returned by ldap_get_dn() and breaks it up into its component parts. Each part is known as a Relative Distinguished Name (RDN). If the dn is in local codepage, use ldap_explode_dn().

ldap_explode_dn_utf8() returns a NULL-terminated array, each component of which contains an RDN from the DN. The notypes parameter is used to request that only the RDN values be returned, not their types.

For example, the distinguished name cn=Bob,c=US would return as either "cn=Bob","c=US",NULL or "Bob","US", 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

dn: (Input) The DN to be exploded in UTF8 codepage (as returned from ldap_get_dn()).
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

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_dn_utf8() is not successful, ld_errno is 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.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_explode_dn_utf8 API.

Related Information

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

API introduced: V5R1

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