QsyRetrieveDigitalIDConfig()--Retrieve Digital ID Configuration Information

  Syntax for QsyRetrieveDigitalIDConfig:

 #include <qsydigid.h>

 void QsyRetrieveDigitalIDConfig
        (void           *Receiver_variable,
         int             Length_of_receiver_variable,
         char           *Format_name,
         void           *Error_code);

  Service Program: QSYDIGID

  Default Public Authority: *USE

  Threadsafe: Yes

The Retrieve Digital ID Configuration Information (QsyRetrieveDigitalIDConfig) API will retrieve digital ID configuration information. This is the information that defines the Lightweight Directory Access Protocol (LDAP) server for where to store digital certificates, and connection information for the server.

Authorities and Locks

QSYDIGID Validation List Object

*USE

QUSRSYS Library

*EXECUTE

Note: For the bind password to be returned, the user must have *USE, *ADD, and *UPD authorities to the validation list.

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.

Format name

INPUT; CHAR(8)

The format of the configuration information to be returned.

The following format name may be used:

RDCI0100

Digital ID configuration information.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

RDCI0100 Format

The following table describes the information that is returned in the receiver variable for the RDCI0100 format. For detailed descriptions of the fields, see Field Descriptions.

Field Descriptions

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Bind DN. The Distinguished Name (DN) of the entry used when binding to the LDAP server.

Bind password. The password to use in association with the bind DN.

Directory DN. The DN for where in the LDAP server the user certificates are to be stored.

Enabled indicator. Specifies whether or not the configuration information is enabled for use.

Length of bind DN. The length of the field that contains the bind distinguished name (DN).

Length of bind password. The length of the field that contains the bind password.

Length of directory DN. The length of the field that contains the directory distinguished name (DN).

Length of server name. The length of the field that contains the server name.

Port number. The port number to use when connecting to the LDAP server.

Offset to bind DN. The offset to the field that contains the bind distinguished name (DN).

Offset to bind password. The offset to the field that contains the bind password.

Offset to directory DN. The offset to the field that contains the directory distinguished name (DN).

Offset to server name. The offset to the field that contains the server name.

Reserved. Reserved data.

Server name. The domain name of the LDAP server on which to store user certificates.

Use SSL indicator. Specifies whether or not Secure Sockets Layer (SSL) is used for secure access when connecting to the LDAP server.

Error Messages