Send Request for IBM i Function (QTVSNDRQ) API


  Required Parameter Group:

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

  Default Public Authority: *USE

  Threadsafe: No

The Send Request for IBM® i Function (QTVSNDRQ) API sends a request to the operating system to perform a particular function.


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.

Request
INPUT; BINARY(4)

The request to be processed by the operating system. Valid binary values are:

1 Cancel Previous Request: Allows the server program to cancel the previous IBM i request. This is similar to selecting option 2 on the System Request menu.
2 Send Break Message: Causes the operating system to issue a break message to the virtual terminal. You can use this to determine whether the virtual terminal is still active.

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.
CPF87F6 E Request value &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 ]