Set Output Address (QsnSetOutAdr) API


  Omissible Parameter Group:

1 Field ID Input Binary(4)
2 Row Input Binary(4)
3 Column Input Binary(4)
4 Command buffer handle Input Binary(4)
5 Low-level environment handle Input Binary(4)
6 Error code I/O Char(*)

  Returned Value:

Return code Output Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Set Output Address (QsnSetOutAdr) API sets the current display address. Subsequent output operations that do not reset the display address use this address. If multiple Set Output Address (QsnSetOutAdr) operations are applied to the same command buffer, only the last QsnSetOutAdr operation is in effect.

This command corresponds indirectly to the 5250 Write to Display command (WTD) with a Set Buffer Address order. (For an indirect operation, a WTD is placed in the command buffer only if one does not already exist in that buffer.)


Authorities and Locks

None


Omissible Parameter Group

Field ID
INPUT; BINARY(4)

The field ID indicating the field at which to set the display address. If this parameter is specified with a nonzero value, the row and column parameters are ignored and the row and column values corresponding to the field ID are used to set the display address. Either the field ID or the row and column parameters must be specified.

Row
INPUT; BINARY(4)

The row at which to set the display address. This parameter is required if the field ID is not specified.

Column
INPUT; BINARY(4)

The column at which to set the display address. This parameter is required if the field ID is not specified.

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 display address is set to the specified location. 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.
CPFA303 E Error occurred for screen I/O operation.
CPFA304 E Data-stream error &1 reported for screen I/O operation.
CPFA305 E Cannot add operation to command buffer.
CPFA307 E Screen position &1, &2 outside of display or window area.
CPFA31E E Required parameter &1 omitted.
CPFA331 E Buffer handle incorrect.
CPFA334 E Low level environment handle incorrect.
CPFA335 E Screen address parameter error.
CPFA33C E Undefined field ID &1.
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

[ Back to top | Dynamic Screen Manager APIs | APIs by category ]