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

FRAME^XGF(): Screen Frame

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


This API draws a box frame on the screen. It displays boxes on the screen.

The FRAME function does not clear or otherwise change the region that it encompasses. If you need to open an empty framed window you should use the WIN^XGF(): Screen Text Window API instead.

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

Acceptable values for the top and bottom parameters range from 0 to IOSL-1. Acceptable values for the left and right parameters range from 0 to IOM-1.



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.

Output Parameters

$x and $y:

Set to the right and bottom specified as parameters.

NOTE: See also: RESTORE^XGF(): Screen Restore and WIN^XGF(): Screen Text Window API APIs.


For example, to draw a box in the center of the screen, do the following:

>D FRAME^XGF(5,20,15,60)


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.