Close Virtual Terminal Path (QTVCLOVT) API

Required Parameter Group:

1	Virtual terminal handle	Input	Char(16)
2	Error code	I/O	Char(*)

Default Public Authority: *USE

Threadsafe: No

The Close Virtual Terminal Path (QTVCLOVT) API closes one or all open virtual terminal paths. To close all open virtual terminal paths, the handle must be set to zero.

Authorities and Locks

None.

Required Parameter Group

Virtual terminal handle: INPUT; CHAR(16)
The reference code for the open virtual terminal path, created with the Open Virtual Terminal Path (QTVOPNVT) API. If this parameter is set to zero, all open virtual terminal paths are closed.
Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.

Error Messages

Message ID	Error Message Text
CPF3C90 E	Literal value cannot be changed.
CPF3CF1 E	Error code parameter not valid.
CPF87F2 E	Virtual terminal handle &1 not valid.
CPF87F7 E	Parameter value &1 not valid.
CPF87F8 E	Unexpected internal system error occurred in program &1.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V2R1

[ Back to top | Virtual Terminal APIs | APIs by category ]