Clear Buffer (QsnClrBuf) API

Required Parameter Group:

Buffer handle

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 Clear Buffer (QsnClrBuf) API clears all commands or data and resets the state of the given buffer. This is the only API that clears or removes data in a buffer.

Authorities and Locks

None

Required Parameter

Buffer handle: INPUT; BINARY(4)
A handle for the buffer to be cleared. The storage associated with the buffer is not deallocated.

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.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPFA31E E	Required parameter &1 omitted.
CPFA331 E	Buffer handle incorrect.

API introduced: V2R3

Top | Dynamic Screen Manager APIs | APIs by category