Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

PREP^XGF(): Screen/Keyboard Setup

Reference Type: Supported, Category: XGF Function Library, ICR#: 3173

Description

The PREP^XGF API sets up the XGF screen and keyboard environments.

Before using any XGF screen functions, you must call the PREP^XGF API. PREP^XGF does the following

In addition, PREP^XGF does everything that the INITKB^XGF(): Keyboard Setup Only API does to set up the XGF keyboard environment, including turning escape processing and terminators on.

NOTE: If you call PREP^XGF, a call to the INITKB^XGF(): Keyboard Setup Only API would be redundant.

Format

  PREP^XGF(xgcuratr)

Input Parameters

none.

 

Output Parameter

xgcuratr:

One-character parameter containing the state of the current video attribute.

Also, the GSET^%ZISS(): Set Up Graphics Variables API is called, so all output variables for screen graphics from GSET^%ZISS are defined.

NOTE: See also: CLEAN^XGF: Screen/Keyboard Exit and Cleanup API.