Initialize Session Description (QsnInzSsnD) API

Required Parameter Group:

1	Session description	Output	Char(*)
2	Length of session description	Input	Binary(4)

Omissible Parameter:

Error code

I/O

Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Initialize Session Description (QsnInzSsnD) API initializes a session description with default values. Unless otherwise specified in the session description (see Format of the Session Description), pointer fields are set to the null pointer, numeric fields to 0, character flag fields to 0, and other character fields to blanks. For example, the default value for the wrap indication is 1, so this field will be set to 1.

Authorities and Locks

Exit Routine Authority: *EXECUTE

Required Parameter Group

Session description: OUTPUT; CHAR(*)
The session description to be initialized.
Length of session description: INPUT; BINARY(4)
The length of the session description parameter.

Omissible Parameter

Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.

Returned Value

Return code: OUTPUT; BINARY(4)
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C1D E	Length specified in parameter &1 not valid.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPFA31E E	Required parameter &1 omitted.

API introduced: V2R3

[ Back to top | Dynamic Screen Manager APIs | APIs by category ]