CLEAN^XGF: Screen/Keyboard Exit and Cleanup

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

Description

The CLEAN^XGF API exits the XGF screen and keyboard environments. It does the following:

• Removes XGF screen and keyboard variables and tables.
  
  
• Turns all video attributes off.
  
  
• Turns echo on.
  
  
• Turns the cursor on.
  
  
• Sets the keypad to numeric mode.
  
  

In addition, CLEAN^XGF does everything that the RESETKB^XGF: Exit XGF Keyboard API does to exit the XGF keyboard environment, including turning terminators and escape processing off. Subsequent READs are processed normally. If you call CLEAN^XGF, a separate call to the RESETKB^XGF: Exit XGF Keyboard API is not necessary.

Format

  CLEAN^XGF

Input Parameters

Output

NOTE: See also: PREP^XGF(): Screen/Keyboard Setup API.