Read Modified Immediate Alternate (QsnReadMDTImmAlt) API


  Omissible Parameter Group:

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

  Returned Value:

Field count Output Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Read Modified Immediate Alternate (QsnReadMDTImmAlt) API reads the contents of all modified fields on the display without requiring an AID-generating key to be pressed. Processing for this API is the same as for the Read Immediate (QsnReadImm) API, except that data is returned only for those fields that have the MDT bit on. The format of the data returned is the same as for the Read Modified Alternate (QsnReadMDTAlt) API.

See Read Immediate (QsnReadImm) API and Read Modified Alternate (QsnReadMDTAlt) API for details.

This command corresponds directly to the 5250 Read MDT Immediate Alternate command.


Restrictions

This command is not supported by all control units. A CPFA306 error occurs if an attempt is made to issue this command to a control unit that does not support it.


Authorities and Locks

None


Omissible Parameter Group

Field count
OUTPUT; BINARY(4)

The variable that contains the number of input fields read after the QsnReadMDTImmAlt API has completed if a direct operation is specified. The parameter is not modified for an indirect operation and the value remains unchanged from whatever was passed.

Input buffer handle
INPUT; BINARY(4)

A handle for the input buffer that receives the result of the input operation if a direct operation is specified. The result can be queried using the input buffer query operations. See Retrieve Pointer to Field Data (QsnRtvFldDta) API and Retrieve Length of Field Data in Buffer (QsnRtvFldDtaLen) API.

Command buffer handle
INPUT; BINARY(4)

A handle for the command buffer in which to store the command.

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

Field count
OUTPUT; BINARY(4)

This API returns the value for the field count parameter if a direct operation was specified, or -1 if an error occurs during processing. If this is an indirect operation, this API returns zero if 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.
CPFA302 E Command buffer or input buffer parameters required.
CPFA304 E Data-stream error &1 reported for screen I/O operation.
CPFA305 E Cannot add operation to command buffer.
CPFA306 E Command not supported by current device.
CPFA309 E Invalid cursor position in command buffer.
CPFA313 E Command buffer already contains an input operation.
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