WINDOW GETINFO

Get Thoroughbred Basic Window Manager Status

This directive places information concerning the current status of the Thoroughbred Basic Windows system in a string array.

Syntax

WINDOW GETINFO ( array-name[ ALL ] ) ["NAME=TBWin-name"]

array-name: is the name of an existing, one-dimensional string array to receive the Thoroughbred Basic Window information. If array-name is specified and is not a one-dimensional string array, this directive re-dimensions it. If this directive dimensions array-name it has one dimension with 26 entries containing the 26 elements described below. If array-name already exists, this directive places the information in entries 0 through the highest entry number or entry 25, whichever is less.
TBWin-name: is an optional specifier that causes this directive to return information on the specified TBWin-name instead of the currently active terminal Thoroughbred Basic Window.

Remarks

This directive is generally available starting with release level 8.1.

The brackets in [ALL] are required and there must not be a space separating [ALL] from array-name.

The following format is used for the information returned:

Array Element/Length: Description
0 - 3 bytes: 2-bytes containing the number of elements returned in binary (not including element 0);

1-byte flag: $00$ if not all elements were returned (array not large enough); $80$ if all elements were returned

1 - 8 bytes: 8-byte name of Thoroughbred Basic Window
2 - 4 bytes: cursor position within Thoroughbred Basic Window: 2-byte binary column; 2-byte binary row
3 - 4 bytes: cursor position within screen: 2-byte binary column; 2-byte binary row
4 - 4 bytes: Thoroughbred Basic Window's starting cursor position: 2-byte binary column; 2-byte binary row
5 - 2 bytes: number of columns in Thoroughbred Basic Window; binary
6 - 2 bytes: number of rows in Thoroughbred Basic Window; binary
7 - 4 bytes: current IOREGION's starting cursor position (if an IOREGION is currently active): 2-byte binary column; 2-byte binary row
8 - 2 bytes: number of columns in current IOREGION; binary
9 - 2 bytes: number of rows in current IOREGION; binary
10 - 2 bytes: number of columns on physical screen; binary
11 - 2 bytes: number of rows on physical screen; binary
12 - 1 byte: the attributes for the current text area:

bit 0 = 0 when background, 1 when foreground

bit 1 = 0 when normal video, 1 when reverse video

bit 2 = 0 when underline off, 1 when underline on

bit 3 = 0 when steady, 1 when blink

bit 4 = not used

bit 5 = 0 when graphics mode off, 1 when graphics mode on

bits 6-7 = not used

13 - 1 byte: the attribute for the current border area (same format as element 12 above)
14 - 1 byte: the SELECTATR option for the current border area (same format as element 12 above); if the SELECTATR option were not used when this Thoroughbred Basic Window was created, this byte is null ($00$)
15 - 4 bytes: color attribute information:

first byte: current color of the area

second byte: border color

third byte: Thoroughbred Basic Window’s original color of the area

fourth byte: not used

16 - 2 bytes: current Thoroughbred Basic Window mode/status flag bytes:

first byte:

bit 0 = not used

bit 1 = 0 when a PANEL is not active, 1 when PANEL is active

bit 2 = 0 when SELECTATR was not specified, 1 when SELECTATR was specified for this Thoroughbred Basic Window

bit 3 = 0 when this Thoroughbred Basic Window is not Window “0”, 1 when this Thoroughbred Basic Window is the main Thoroughbred Basic Window (Window “0”)

bit 4 = 0 when an IOREGION is not active, 1 when an IOREGION is active

bit 5 = 0 when the Thoroughbred Basic Window does not have a border, 1 when the Thoroughbred Basic Window has a border

bit 6 = 0 when “wrap” is disabled, 1 when “wrap” is enabled

bit 7 = 0 when “scroll” is disabled, 1 when “scroll” is enabled

second byte: not used

17 - 2 bytes: the total number of panels defined for this Thoroughbred Basic Window; binary
18 - 2 bytes: the total number of defined Thoroughbred Basic Windows; binary
19 - 2 bytes: the total number of Thoroughbred Basic Windows not saved; binary
20 - 2 bytes: the total number of Thoroughbred Basic Windows saved; binary
21 - 4 bytes: Thoroughbred Basic Windows Manager mode/status flags:

first byte:

bits 0-2 = not used

bit 3 = 0 for monochrome terminal, 1 for color terminal

bit 4 = 0 if this terminal is not a “take a spot” terminal, 1 if this is a “take a spot “ terminal

bit 5 = 0 if this terminal does not have spot handling, 1 if it does have spot handling

bit 6 = 0 when this terminal does not have 80/132-column capability, 1 when terminal does have 80/132-column capability

bit 7 = 0 when terminal does not auto-wrap at end of line, 1 when terminal does auto-wrap at end of line

second-fourth bytes:

not used

22 - 4 bytes: Thoroughbred Basic Windows Manager and TCONFIG8 mnemonic status flags:

first byte:

bit 0 = 0 when BG/EG mnemonics not defined, 1 when defined

bit 1 = 0 when SB/SF mnemonics not defined, 1 when defined

bit 2 = 0 when BU/EU mnemonics not defined, 1 when defined

bit 3 = 0 when BR/ER mnemonics not defined, 1 when defined

bit 4 = 0 when CO/CN mnemonics not defined, 1 when defined

bit 5 = 0 when CS mnemonic not defined, 1 when defined

bit 6 = 0 when “16 status state” attribute setting mnemonics are not defined, 1 when they are defined bit 7 = 0 when line graphics are not available for borders (uses “*” for corners, “-” for top and bottom, and “|” for sides), 1 when line graphics mnemonics defined

second byte:

bit 0 = not used

bit 1 = 0 when 1 or more graphics characters (GO through GF) has been set to the default, 1 when all 16 graphics characters (GO through GF) are defined

bit 2 = 0 when CF mnemonic not defined, 1 when defined

bit 3 = 0 when BV mnemonic not defined, 1 when defined

bit 4 = 0 when BF mnemonic not defined, 1 when defined

bit 5 = 0 when BD mnemonic not defined, 1 when defined

bit 6 = 0 when BB mnemonic not defined, 1 when defined

bit 7 = 0 when EB mnemonic not defined, 1 when defined

third - fourth bytes: not used

23 - 4 bytes: total amount of memory currently being used by the Thoroughbred Basic Windows Manager for this task; binary
24 - 8 bytes: Terminal Model Code name for this task from the TCONFIG8 file
25 - 64 bytes: Host computer device name for this serial port (e.g. "tty01"), left justified, padded with nulls ($00$)

WINDOW GETINFO

Syntax

Remarks

See also