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 |
(none) |
|
|
AG_AUTOPARENT |
87 |
3 |
? tab(-10,AG_AUTOPARENT); ctrlid; chr(127); comparable to MX_AUTOPARENT |
|
AG_BEVEL |
13 |
3 |
|
|
AG_BROWSEFOLDER |
70 |
3,5 |
|
|
AG_CHKPCNET |
74 |
3,5 |
|
|
AG_CLIPBOARD |
65 |
3 |
|
|
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 |
|
|
AG_DATETIME |
64 |
1,5 |
|
|
AG_DELAYOP |
107 |
(none) |
|
|
AG_DESIGN |
61 |
6 |
Design mode operations |
|
AG_DISCONNECTPW |
53 |
1 |
|
|
AG_DPM |
120 |
(none) |
|
|
AG_EVENTWAIT |
33 |
3 |
|
|
AG_EVTMSG |
57 |
(none) |
|
|
AG_FILESTATS |
31 |
3,5 |
|
|
AG_FLASHWINDOW |
28 |
(none) |
|
|
AG_FTP |
22 |
1,2,5 |
|
|
AG_FTPSETPW |
29 |
1,2 |
|
|
AG_FTPSYNC |
55 |
1,2 |
Used internally with ATSYNC.LIT. Please inquire if you are interested in this function. |
|
AG_GETDPI |
111 |
3,5 |
|
|
AG_GETENV |
45 |
4,5 |
|
|
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 |
|
|
AG_GETSHELLPATH |
71 |
3,5 |
|
|
AG_HANDSHAKE |
85 |
1 |
Send/receive various info with ATE client |
|
AG_HOLDKBD |
36 |
1, 6 |
|
|
AG_IATIMEOUT |
79 |
1,3,5 |
|
|
AG_IMAGE |
35 |
3 |
|
|
AG_ISFOREGROUND |
78 |
5 |
|
|
AG_MENU |
21 |
3,5 |
|
|
AG_MESSAGEBEEP |
3 |
(none) |
|
|
AG_MESSAGEBOXOK |
4 |
3,5 |
|
|
AG_MESSAGEBOXSTD |
17 |
3,5 |
|
|
AG_MINTITLE |
1 |
(none) |
|
|
AG_MKDIR |
32 |
3,5 |
|
|
AG_MOUSE |
100 |
(none) |
|
|
AG_NEWPRODUCT |
6 |
6 |
Allows override of certain info in About box. |
|
AG_OPTIONS |
69 |
4,5 |
|
|
AG_OSVER |
66 |
3,5 |
|
|
AG_PALETTE |
15 |
5 |
Query colors. See Define or Query Color Palette. |
|
AG_PLAYSOUND |
105 |
(none) |
|
|
AG_RAWDATA |
83 |
1 |
Send raw data |
|
AG_RELEASEKBD |
49 |
1,3 |
|
|
AG_RESETWINDOW |
16 |
(none) |
|
|
AG_SAVERES |
40 |
(none) |
|
|
AG_SBRFLAGS |
102 |
3,4,5 |
|
|
AG_SCROLLBACK |
109 |
(none) |
|
|
AG_SENDKBD |
82 |
(none) |
|
|
AG_SETCOLOR |
15 |
(none) |
|
|
AG_SETCURSOR |
50 |
(none) |
|
|
AG_SETENV |
77 |
3,4 |
|
|
AG_SHLEXEC |
24 |
3,5 |
|
|
AG_SHORTCUT |
72 |
3,5 |
|
|
AG_SHOWFONT |
99 |
(none) |
Deprecated. Display font info |
|
AG_SHOWWINDOW |
27 |
3 |
|
|
AG_SPOOLCFG |
54 |
1 |
|
|
AG_STATUSLINES |
34 |
(none) |
|
|
AG_SYSBCLR |
26 |
3 |
|
|
AG_SYSCOLOR |
63 |
(none) |
|
|
AG_TRACE |
76 |
4,5 |
|
|
AG_WALLPAPER |
39 |
(none) |
|
|
AG_WEBCACHE |
108 |
3,5 |
|
|
AG_WINEXEC |
23 |
5 |
|
|
AG_WINPTR |
56 |
3,5 |
|
|
AG_WINSETTINGS |
46 |
3,5 |
|
|
AG_WINTITLE |
2 |
(none) |
|
|
AG_WRAP |
62 |
(none) |
|
|
AG_XFUNC |
25 |
5 |
Call SBX as a Function (numeric) |
|
AG_XFUNC2 |
73 |
(none) |
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 subroutine (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 |
(none) |
|
|
AG_WINTITLE |
2 |
(none) |
|
|
AG_MESSAGEBEEP |
3 |
(none) |
|
|
AG_MESSAGEBOXOK |
4 |
3,5 |
|
|
AG_NEWPRODUCT |
6 |
6 |
Allows override of certain info in About box. |
|
AG_BEVEL |
13 |
3 |
|
|
AG_SETCOLOR |
15 |
(none) |
|
|
AG_PALETTE |
15 |
5 |
Query colors. See Define or Query Color Palette. |
|
AG_RESETWINDOW |
16 |
(none) |
|
|
AG_MESSAGEBOXSTD |
17 |
3,5 |
|
|
AG_CONTROL |
20 |
3,5 |
|
|
AG_MENU |
21 |
3,5 |
|
|
AG_FTP |
22 |
1,2,5 |
|
|
AG_WINEXEC |
23 |
5 |
|
|
AG_SHLEXEC |
24 |
3,5 |
|
|
AG_XFUNC |
25 |
5 |
Call SBX as a Function (numeric) |
|
AG_SYSBCLR |
26 |
3 |
|
|
AG_SHOWWINDOW |
27 |
3 |
|
|
AG_FLASHWINDOW |
28 |
(none) |
|
|
AG_FTPSETPW |
29 |
1,2 |
|
|
AG_FILESTATS |
31 |
3,5 |
|
|
AG_MKDIR |
32 |
3,5 |
|
|
AG_EVENTWAIT |
33 |
3 |
|
|
AG_STATUSLINES |
34 |
(none) |
|
|
AG_IMAGE |
35 |
3 |
|
|
AG_HOLDKBD |
36 |
1, 6 |
|
|
AG_WALLPAPER |
39 |
(none) |
|
|
AG_SAVERES |
40 |
(none) |
|
|
AG_ATEDISCONNECT |
44 |
1 |
Force immediate ATE Disconnect |
|
AG_GETENV |
45 |
4,5 |
|
|
AG_WINSETTINGS |
46 |
3,5 |
|
|
AG_GETOFD |
47 |
3,5 |
|
|
AG_RELEASEKBD |
49 |
1,3 |
|
|
AG_SETCURSOR |
50 |
(none) |
|
|
AG_DISCONNECTPW |
53 |
1 |
|
|
AG_SPOOLCFG |
54 |
1 |
|
|
AG_FTPSYNC |
55 |
1,2 |
Used internally with ATSYNC.LIT. Please inquire if you are interested in this function. |
|
AG_WINPTR |
56 |
3,5 |
|
|
AG_EVTMSG |
57 |
(none) |
|
|
AG_DESIGN |
61 |
6 |
Design mode operations |
|
AG_WRAP |
62 |
(none) |
|
|
AG_SYSCOLOR |
63 |
(none) |
|
|
AG_DATETIME |
64 |
1,5 |
|
|
AG_CLIPBOARD |
65 |
3 |
|
|
AG_OSVER |
66 |
3,5 |
|
|
AG_ATTRSUB |
68 |
(none) |
|
|
AG_OPTIONS |
69 |
4,5 |
|
|
AG_BROWSEFOLDER |
70 |
3,5 |
|
|
AG_GETSHELLPATH |
71 |
3,5 |
|
|
AG_SHORTCUT |
72 |
3,5 |
|
|
AG_XFUNC2 |
73 |
(none) |
Call SBX as a Function (no return value) |
|
AG_CHKPCNET |
74 |
3,5 |
|
|
AG_XFUNCS |
75 |
5 |
Call SBX as a Function (string) |
|
AG_TRACE |
76 |
4,5 |
|
|
AG_SETENV |
77 |
3,4 |
|
|
AG_ISFOREGROUND |
78 |
5 |
|
|
AG_IATIMEOUT |
79 |
1,3,5 |
|
|
AG_SENDKBD |
82 |
(none) |
|
|
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); comparable 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 |
(none) |
Deprecated. Display font info. |
|
AG_MOUSE |
100 |
(none) |
|
|
AG_SBRFLAGS |
102 |
3,4,5 |
|
|
AG_PLAYSOUND |
105 |
(none) |
|
|
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_DELAYOP |
107 |
(none) |
|
|
AG_WEBCACHE |
108 |
3,5 |
|
|
AG_SCROLLBACK |
109 |
(none) |
|
|
AG_GETDPI |
111 |
3,5 |
|
|
AG_DPM |
120 |
(none) |