Reference Type: Supported, Category: XGF Function Library, Integration Agreement: 3173
This API sets up the XGF keyboard environment only. You should call
INITKB^XGF once, before you start making calls to the $$READ^XGF function. This
API turns on escape processing and any terminators that are passed.
Use this API only if you are using XGF's Keyboard Reader independently from XGF's screen functions. Otherwise, a call to the PREP^XGF(): Screen/Keyboard Setup API does everything to set up keyboard processing that INITKB^XGF does, and a separate call to INITKB^XGF is not necessary.
Unlike the PREP^XGF(): Screen/Keyboard Setup API, INITKB^XGF does not set the keypad to application mode.
INITKB does not call %ZISS. Thus, documented Kernel variables such as IOKPAM and IOKPNM are not available for use without a separate call to the ENS^%ZISS(): Set Up Screen Handling Variables API.
(optional) String of characters that should terminate the
If this parameter is not passed, or if it is an empty string, the terminators are not turned on.
NOTE: See also: RESETKB^XGF: Exit XGF Keyboard API.
August 26, 2011