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

INITKB^XGF(): Keyboard Setup Only

Reference Type: Supported, Category: XGF Function Library, Integration Agreement: 3173

Description

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.

Format

  INITKB^XGF([term_str])

Input Parameters

term_str:

(optional) String of characters that should terminate the READ.

This parameter can be one of two forms:

  • A single asterisk ("*") character turns on all terminators.

  • The string of terminating characters, such as $C(9,13,127).

If this parameter is not passed, or if it is an empty string, the terminators are not turned on.

Output

none

 

NOTE: See also: RESETKB^XGF: Exit XGF Keyboard API.

 


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 26, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.