RESETKB^XGF(): Exit XGF Keyboard

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

Description

The RESETKB^XGF API exits the XGF keyboard environment. You should use the RESETKB^XGF call once you finish making calls to the $$READ^XGF(): Read Using Escape Processing function. The RESETKB^XGF API turns terminators and escape processing off and removes any XGF keyboard environment variables. Subsequent READs are processed normally.

Use this API only if you are using XGF's Keyboard Reader independently from XGF's screen functions. Otherwise, a call to the CLEAN^XGF: Screen/Keyboard Exit and Cleanup API does everything to clean up keyboard processing that the RESETKB^XGF: Exit XGF Keyboard API does, and a separate call to the RESETKB^XGF API is not necessary.

Unlike the CLEAN^XGF: Screen/Keyboard Exit and Cleanup API does not set the keypad to numeric mode.

Format

  RESETKB^XGF

Input Parameters

Output

NOTE: See also: INITKB^XGF(): Keyboard Setup Only API.