Change Session (QsnChgSsn) API

Required Parameter Group:

1	Session handle	Input	Binary(4)
2	Session description	Input	Char(*)
3	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 Change Session (QsnChgSsn) API changes the session description for the given session. If the session is currently displayed, it will be redrawn to reflect any changes.

Authorities and Locks

Exit Routine Authority: *EXECUTE

Required Parameter Group

Session handle: INPUT; BINARY(4)
A handle for the session for which the session description is to be changed.
Session description: INPUT; CHAR(*)
The format of the session description is shown in Format of the Session Description.
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 essages 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.
CPFA314 E	Memory allocation error.
CPFA318 E	Error calling exit routine.
CPFA31E E	Required parameter &1 omitted.
CPFA343 E	Output operation not done.
CPFA344 E	The file &2 in library &3 is not valid.
CPFA345 E	The invite active flag is not valid.
CPFA3D1 E	Session description value is incorrect.
CPFA3D6 E	Session handle is incorrect.

API introduced: V2R3

Top | Dynamic Screen Manager APIs | APIs by category