Generate a Beep (QsnBeep) API

Omissible Parameter Group:

1	Command buffer handle	Input	Binary(4)
2	Low-level environment handle	Input	Binary(4)
3	Error code	I/O	Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Generate a Beep (QsnBeep) API generates a beep. The display address is not affected by this command.

This command corresponds directly to the 5250 Write to Display (WTD) command with control character 1 equal to X'00' and control character 2 equal to X'04'. If this is an indirect operation, this API issues a new WTD command to the command buffer.

Authorities and Locks

None

Restrictions

The same restrictions apply as for the Write Data (QsnWrtDta) API (see Restrictions).

Omissible Parameter Group

Command buffer handle: INPUT; BINARY(4)
A handle for the command buffer in which to store the command. If this parameter is omitted or specified as 0, this is a direct operation and the beep is generated immediately. Otherwise, this is an indirect operation and the command is stored in the command buffer without an I/O operation taking place.
Low-level environment handle: INPUT; BINARY(4)
The low-level environment that the operation applies to. If this parameter is omitted or given with a value of zero, the default low-level environment is used.
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.
CPFA301 E	Command buffer is full.
CPFA304 E	Data-stream error &1 reported for screen I/O operation.
CPFA305 E	Cannot add operation to command buffer.
CPFA31E E	Required parameter &1 omitted.
CPFA331 E	Buffer handle incorrect.
CPFA334 E	Low level environment handle incorrect.
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.

API Introduced: V2R3

Top | Dynamic Screen Manager APIs | APIs by category