ldap_explode_dn()--Break a Distinguished Name into Its Components

Syntax #include <ldap.h> char **ldap_explode_dn( char *dn, int notypes) Threadsafe: Yes

The ldap_explode_dn() function uses the distinguished name returned by ldap_get_dn() and breaks it up into its component parts. Each part is known as a Relative Distinguished Name (RDN).

ldap_explode_dn() 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 OS/400 authority is required. All authority checking is done by the LDAP server.

Parameters

dn

(Input) Specifies the DN to be exploded (as returned from ldap_get_dn()).

notypes

(Input) Specifies if type information is to be returned with each RDN. If non-zero, the type information will be 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)

if the request was successful.

NULL

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

Error Conditions

If ldap_explode_dn() 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 ldap_get_errno() function to retrieve the error information.

Error Messages

    The following message may be set from this function.
    CPF3CF2 E  Error(s) occurred during running of ldap_explode_dn API.

Related Information

    ldap_get_dn() -- Extract the DN from an entry.
    ldap_explode_rdn() -- Break a Relative Distinguished Name into Its Components.