Get Client Handle (QzcaGetClientHandle) API

Required Parameter Group:

  Service Program: QZCACLT

  Default Public Authority: *EXCLUDE

  Threadsafe: No

The Get Client Handle (QzcaGetClientHandle) API allows applications to know the client handle assigned if the client ID is known.

Authorities and Locks

Client handle: OUTPUT; CHAR(12)
A unique key to identify this managed node. This parameter was returned in the client handle assigned parameter on the Add Client API.
Client ID: INPUT; CHAR(*)
An administratively assigned system name for this managed client. By convention, this is the client's fully qualified domain name. A NULL-terminated string is required for this string. The length of the client ID is 1 through 255.
Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C1E E	Required parameter &1 omitted.
CPF3C36 E	Number of parameters, &1, entered for this API was not valid.
CPF3C90 E	Literal value cannot be changed.
CPF3CF1 E	Error code parameter not valid.
CPF5E88 E	Parameter length not valid.
CPF5E95 E	Internal processing error.
CPF5E96 E	Client ID does not exist.
CPF9845 E	Error occurred while opening file &1.
CPF9846 E	Error while processing file &1 in library &2.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V3R6