ldap_explode_rdn()--Break a Relative Distinguished Name into Its Components

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

The ldap_explode_rdn() function uses the relative distinguished name RDN (perhaps as returned by ldap_explode_dn()) and breaks it up into its component parts.

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

Parameters

rdn

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

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

Components of 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_rdn() 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_rdn API.

Related Information

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