Set Screen Image (QUISETSC) API

The Set Screen Image (QUISETSC) API establishes the screen image for a UIM application. This API is used when a pop-up window is displayed over a panel that was not displayed using the same UIM application.

For displaying pop-up windows over data description specifications (DDS) screens, it is the responsibility of the application program to save and restore the display before and after displaying the pop-up window. This can be done by specifying RSTDSP(*YES) for the DDS display file.

When the QUISETSC API is called, a read screen command is sent to the requesting program device. The screen image returned from the read screen operation is saved for the open application. Subsequent panels displayed in pop-up windows are displayed on top of this image. Using this API to set the screen image is functionally similar to using the Display Panel (QUIDSPP) API to establish the primary panel on which pop-up windows are overlaid.

The UIM does not preserve the extended character buffer (ECB) attributes on the underlying panel. This means that the UIM issues a read screen command instead of a read screen with ECB command. Any highlighting on the underlying panel that was specified using ECB attributes is lost. When the application redisplays the underlying panel after the pop-up window is removed, the correct highlighting is restored.

No half-index ECB attributes are preserved.

Any double-byte character string (DBCS) data in the underlying panel is supported, including DBCS data whose shift-in and shift-out characters are specified in ECB attributes.

Authorities and Locks

None.

Required Parameter Group

Application handle

INPUT; CHAR(8)

The application handle assigned by the UIM and returned to the application program by the Open Display Application (QUIOPNDA) API when the application is opened.

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