ldap_default_dn_set()-- Store the User's Default DN

Syntax

 #include <ldap.h>
 
 int ldap_default_dn_set(
       char           *default_dn,
       char           *filename)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_default_dn_set() API is used to store the user's default DN. The DN can be obtained by calling ldap_default_dn_get().

The default DN is stored on disk. For IBM^® i, the default file the information will be stored in will be called ldap_user_info and will be put into the user's home directory. A user's home directory is specified in the user's profile. The home directory must be created prior to calling ldap_default_dn_set() and is not created as part of the creation of a user's profile. It will be stored in the local character set format.

Authorities and Locks

The caller must have Execute (*X) authority to each directory in the path name preceding the name of the user information file. The caller must have Write (*W) authority to the user information file. If the filename file doesn't exist in the directory when calling ldap_default_dn_set, the caller must have Write (*W) authority to the file's parent directory.

Parameters

default_dn: (input) Specifies the user's default Distinguished Name.
filename: (Input) Specifies an alternative location for the user's default Distinguished Name storage. If only a filename is given for the filename parameter then a file will be created in the current directory, otherwise, if a path is given as well as a filename as part of the filename parameter, the file will be created following the given path. If filename is NULL, a file called ldap_user_info will be created into the user's home directory.

Return Value

LDAP_SUCCESS: if the request was successful.
another LDAP error code: if the request was not successful.

Error Conditions

The ldap_default_dn_set() API will return an LDAP error code if not successful. See LDAP Client API Error Conditions for possible LDAP error code values.

Error Messages

The following message may be sent from this function.

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

Related Information

ldap_default_dn_get() -- Retrieve the User's Default DN.
ldap_enetwork_domain_set() -- Store the User's Default eNetwork Domain Name.
ldap_enetwork_domain_get() -- Retrieve the User's Default eNetwork Domain Name.

API introduced: V4R5

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