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

WIN^XGF(): Screen Text Window

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


This API opens a text window on the screen and optionally remember what it overlays. If the save root parameter is not passed, you cannot restore the screen behind the window.

In order to save the screen region that the window overlays it is absolutely necessary that screen output is done using only the functions in the XGF Function library. If you use the M WRITE command for output, the screen contents cannot be saved.

A call to the PREP^XGF(): Screen/Keyboard Setup API must be made at some point prior to calling WIN^XGF.

Specify the array node under which to save the overlaid screen region in closed root and fully resolved form (i.e., closed right parenthesis and with variable references such as $J fully resolved). Using the M $NAME function is a quick way to pass fully resolved node specifications.

To restore screens you save with the WIN^XGF function, use the RESTORE^XGF(): Screen Restore API.



Input Parameters


(required) Top screen coordinate for box.


(required) Left screen coordinate for box.


(required) Bottom screen coordinate for box.


(required) Right screen coordinate for box.


(optional) Global/local array node, closed root form.

Output Parameters


If you specify a node as a fifth parameter for save_root, WIN^XGF saves the screen region you overlay in an array at that node.

$x and $y:

Set to the right and bottom coordinates you specify as parameters.

NOTE: See also: CLEAR^XGF(): Screen Clear Region, FRAME^XGF(): Screen Frame, RESTORE^XGF(): Screen Restore, and SAVE^XGF(): Screen Save APIs.

Example 1

To draw an empty box in the center of the screen (and save the underlying screen region under array SELECT), do the following:

>D WIN^XGF(5,20,15,60,"SELECT")

Example 2

To save the same window to a global array (to illustrate the use of $NAME to specify a fully resolved root), do the following:

>D WIN^XGF(5,20,15,60,$NA(^TMP($J)))


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.