TAB(-10,x) Function Listing

The following table is sorted alphabetically by symbol name. The same table sorted by value is provided after the Notes, below.

Symbol

Value

Notes

Description

AG_ATEDISCONNECT

44

1

Force immediate ATE Disconnect

AG_ATTRSUB

68

 

Change Underline Attribute

AG_AUTOPARENT

87

3

? tab(-10,AG_AUTOPARENT); ctrlid; chr(127); equivalent to MX_AUTOPARENT

AG_BEVEL

13

3

Set Beveling Flags; equivalent to MX_BEVEL

AG_BROWSEFOLDER

70

3,5

Select Windows Folder; equivalent to MX_BROWSEFOLDER

AG_CHKPCNET

74

3,5

Check ATE network state; equivalent to MX_CHKPCNET

AG_CLIPBOARD

65

3

Perform Clipboard Operations; equivalent to MX_CLIPBOARD

AG_CLRINBUF

106

1,3

Clears the ATE client input buffer: ? tab (-10,AG_CLRINBUF); chr(127). Note that MX_CLRINBUF will automatically issue this command, so you would normally only use AG_CLRINBUF separately in specialized situations.

AG_CONTROL

20

3,5

Edit GUI Control

AG_DATETIME

64

1,5

Retrieve ATE Date and Time

AG_DELAYOP

107

 

Run Delayed Operation in Background

AG_DESIGN

61

6

Design mode operations

AG_DISCONNECTPW

53

1

Password for Disconnect

AG_EVENTWAIT

33

3

Event Wait; equivalent to AUI_EVENTWAIT

AG_EVTMSG

57

 

Output Debug Message

AG_FILESTATS

31

3,5

Get File Stats; equivalent to MX_FILESTATS

AG_FLASHWINDOW

28

 

Flash Window

AG_FTP

22

1,2,5

FTP

AG_FTPSETPW

29

1,2

Set FTP Login / Password

AG_FTPSYNC

55

1,2

Used internally with ATSYNC.LIT. Please inquire if you are interested in this function.

AG_GETENV

45

4,5

Get ATE Environment Variable

AG_GETFLAGS

92

6

? tab(-10,AG_GETFLAGS); opcode; chr(127);  Retrieves a single digit (0 or 1) followed by a CRLF, indicating if theme support is active on the client.

AG_GETOFD

47

3,5

Display Open/Save File Dialog; equivalent to MX_GETOFD

AG_GETSHELLPATH

71

3,5

Retrieve Windows Path; equivalent to MX_GETSHELLPATH

AG_HANDSHAKE

85

1

Send/receive various info with ATE client

AG_HOLDKBD

36

1, 6

Set ATE Keyboard Hold.

AG_IATIMEOUT

79

1,3

Set/Retrieve Timeout Period; equivalent to MX_IATIMEOUT

AG_IMAGE

35

3

Image Processing.

AG_ISFOREGROUND

78

 

Test for Foreground Status

AG_MENU

21

3,5

Edit Menu Control, invoke menu command

AG_MESSAGEBEEP

3

 

Beep

AG_MESSAGEBOXOK

4

3,5

Display OK / Cancel Message Box

AG_MESSAGEBOXSTD

17

3,5

 

Display Standard Message Dialog

AG_MINTITLE

1

 

Set Minimized Window Title

AG_MKDIR

32

3,5

Make Directory; equivalent to MX_MKDIR

AG_MOUSE

100

 

Set / Restore AutoMouse

AG_NEWPRODUCT

6

6

Allows override of certain info in About box.

AG_OPTIONS

69

4,5

Set/retrieve OPTIONS for ATE

AG_OSVER

66

3

Get OS Info

AG_PALETTE

15

5

Query colors. See Define or Query Color Palette.

AG_RAWDATA

83

1

Send raw data

AG_RELEASEKBD

49

1,3

Release ATE Keyboard Release

AG_RESETWINDOW

16

 

Reset Window

AG_SAVERES

40

 

Save / Restore Screen with ID

AG_SBRFLAGS

102

4,5

Set / Retrieve SBR Flags

AG_SENDKBD

82

 

Send Keyboard Characters

AG_SETCOLOR

15

 

Define or Query Color Palette

AG_SETCURSOR

50

 

Set Mouse Cursor

AG_SETENV

77

3,4

Set Environment Variable; similar to MX_SETENV but applies to client side.

AG_SHLEXEC

24

3,5

Shell Execute; equivalent to MX_SHELLEX

AG_SHORTCUT

72

3,5

Create A Shortcut; equivalent to MX_SHORTCUT

AG_SHOWFONT

99

 

Display font info (deprecated)

AG_SHOWWINDOW

27

3

Show Window; equivalent to MX_SHOWWINDOW

AG_SPOOLCFG

54

1

Auxiliary Port Control

AG_STATUSLINES

34

 

Enable / Disable Status Lines

AG_SYSCOLOR

63

 

Change RGB Value

AG_SYSBCLR

26

3

Associate A-Shell and Windows Colors; equivalent to MX_SYSBCLR

AG_TRACE

76

4,5

Clear/Set/Query ATE Trace Flags

AG_WALLPAPER

39

 

Display Wallpaper

AG_WEBCACHE

108

 

Get/Set WEBCACHE Options

AG_WINEXEC

23

5

Execute Windows Command Line

AG_WINPTR

56

3,5

Display printer selection dialog; equivalent to MX_WINPTR

AG_WINSETTINGS

46

3,5

Get / Set / Load / Save Settings; equivalent to MX_WINSETTINGS

AG_WINTITLE

2

 

Set Normal Window Title

AG_WRAP

62

 

Enable/Disable Wrap

AG_XFUNC

25

5

Call SBX as a Function (numeric)

AG_XFUNC2

73

 

Call SBX as a Function (no return value)

AG_XFUNCS

75

5

Call SBX as a Function (string)

 

Notes

1 Applies only to ATE. It may be technically possible to use the command in non-ATE situations, but it doesn’t make much sense.

2 Requires that an FTP service be activated on the server, which uses the same root directory as A-Shell running on the server (which is rarely the case with Windows).

3 The MX_xxx or AUI_xxx equivalent is preferable, as it will be simpler to use (no need for an INPUT statement to retrieve the result) and will automatically route the command to the ATE client or handle locally on the application server, depending on the environment. Note, however, that in some cases, the MX_xxx or AUI_xxx equivalent may support an option of whether to perform the function on the server or forward it to the ATE client, whereas the AG_xxx functions are always sent to the client. See the MX_xxx / AUI_xxx documentation for details. In the case of A-Shell/Windows without ATSD, the client and server are effectively the same.

4 Similar to the MX_xxx equivalent, but always works relative to the client PC, whereas the MX_xxx equivalent always works relative to the application server. In the case of A-Shell/Windows without ATE, the two are functionally the same.

5 In lieu of using ? Tab(-10, AG_xxx) followed by some form of INPUT to retrieve the response, we recommend the use of the MX_AGWRAPPER function as a way of combining the two operations into a single XCALL (provided server is running A-Shell and the MX_AGWRAPPER function is available).

6 Used mostly or entirely for internal purposes only. Please inquire if you want more information on this function.

Table Sorted by Value

Symbol

Value

Notes

Description

AG_MINTITLE

1

 

Set Minimized Window Title

AG_WINTITLE

2

 

Set Normal Window Title

AG_MESSAGEBEEP

3

 

Beep

AG_MESSAGEBOXOK

4

3,5

Display OK / Cancel Message Box

AG_NEWPRODUCT

6

6

Allows override of certain info in About box.

AG_BEVEL

13

3

Set Beveling Flags; equivalent to MX_BEVEL

AG_PALETTE

15

5

Query colors. See Define or Query Color Palette.

AG_SETCOLOR

15

 

Define or Query Color Palette

AG_RESETWINDOW

16

 

Reset Window

AG_MESSAGEBOXSTD

17

3,5

 

Display Standard Message Dialog

AG_CONTROL

20

3,5

Edit GUI Control

AG_MENU

21

3,5

Edit Menu Control, invoke menu command

AG_FTP

22

1,2,5

FTP

AG_WINEXEC

23

5

Execute Windows Command Line

AG_SHLEXEC

24

3,5

Shell Execute; equivalent to MX_SHELLEX

AG_XFUNC

25

5

Call SBX as a Function (numeric)

AG_SYSBCLR

26

3

Associate A-Shell and Windows Colors; equivalent to MX_SYSBCLR

AG_SHOWWINDOW

27

3

Show Window; equivalent to MX_SHOWWINDOW

AG_FLASHWINDOW

28

 

Flash Window

AG_FTPSETPW

29

1,2

Set FTP Login / Password

AG_FILESTATS

31

3,5

Get File Stats; equivalent to MX_FILESTATS

AG_MKDIR

32

3,5

Make Directory; equivalent to MX_MKDIR

AG_EVENTWAIT

33

3

Event Wait; equivalent to AUI_EVENTWAIT

AG_STATUSLINES

34

 

Enable / Disable Status Lines

AG_IMAGE

35

3

Image Processing.

AG_HOLDKBD

36

1, 6

Put ATE into "keyboard hold" mode

AG_WALLPAPER

39

 

Display Wallpaper

AG_SAVERES

40

 

Save / Restore Screen with ID

AG_ATEDISCONNECT

44

1

Force immediate ATE Disconnect

AG_GETENV

45

4,5

Get ATE Environment Variable

AG_WINSETTINGS

46

3,5

Get / Set / Load / Save Settings; equivalent to MX_WINSETTINGS

AG_GETOFD

47

3,5

Display Open/Save File Dialog; equivalent to MX_GETOFD

AG_RELEASEKBD

49

1,3

Release (un-buffer) keyboard ; equivalent to MX_RELEASEKBD

AG_SETCURSOR

50

 

Set Mouse Cursor; same as tab(-1,160)

AG_DISCONNECTPW

53

1

Password for Disconnect

AG_SPOOLCFG

54

1

Auxiliary Port Control

AG_FTPSYNC

55

1,2

Used internally with ATSYNC.LIT. Please inquire if you are interested in this function.

AG_WINPTR

56

3,5

Display printer selection dialog; equivalent to MX_WINPTR

AG_EVTMSG

57

 

Output debug message

AG_DESIGN

61

6

Design mode operations

AG_WRAP

62

 

Enable/Disable Wrap

AG_SYSCOLOR

63

 

Change RGB Value

AG_DATETIME

64

1,5

Retrieve ATE Date and Time

AG_CLIPBOARD

65

3

Perform Clipboard Operations; equivalent to MX_CLIPBOARD

AG_OSVER

66

3

Get OS Info

AG_ATTRSUB

68

 

Change Underline Attribute

AG_OPTIONS

69

4,5

Set/retrieve OPTIONS for ATE

AG_BROWSEFOLDER

70

3,5

Select Windows Folder; equivalent to MX_BROWSEFOLDER

AG_GETSHELLPATH

71

3,5

Retrieve Windows Path; equivalent to MX_GETSHELLPATH

AG_SHORTCUT

72

3,5

Create A Shortcut; equivalent to MX_SHORTCUT

AG_XFUNC2

73

 

Call SBX as a Function (no return value)

AG_CHKPCNET

74

3,5

Check ATE network state; equivalent to MX_CHKPCNET

AG_XFUNCS

75

5

Call SBX as a Function (string)

AG_TRACE

76

4,5

Clear/Set/Query ATE Trace Flags

AG_SETENV

77

3,4

Set Environment Variable; equivalent to MX_SETENV

AG_ISFOREGROUND

78

 

Test for Foreground Status

AG_IATIMEOUT

79

1,3

Set/Retrieve Timeout Period; equivalent to MX_IATIMEOUT

AG_SENDKBD

82

 

Send Keyboard Characters

AG_RAWDATA

83

1

Send raw data

AG_HANDSHAKE

85

1

Send/receive various info with ATE client

AG_AUTOPARENT

87

3

? tab(-10,AG_AUTOPARENT); ctrlid; chr(127); equivalent to MX_AUTOPARENT

AG_GETFLAGS

92

6

? tab(-10,AG_GETFLAGS); opcode; chr(127);   Retrieves a single digit (0 or 1) followed by a CRLF, indicating if theme support is active on the client.

AG_SHOWFONT

99

 

Display font info (deprecated)

AG_CLRINBUF

106

 

Clears the ATE client input buffer: ? tab (-10,AG_CLRINBUF); chr(127). Note that MX_CLRINBUF will automatically issue this command, so you would normally only use AG_CLRINBUF separately in specialized situations.

AG_DELAYOP

107

 

Run Delayed Operation in Background