Please enable JavaScript to view this site.

A-Shell Consolidated Reference

Navigation: Tab Functions > ATE Functions

Tab(-10,x) Function Listing

Scroll Prev Top Next More

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)

Change underline attribute

AG_AUTOPARENT

87

3

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

AG_BEVEL

13

3

Set beveling flags

AG_BROWSEFOLDER

70

3,5

Select Windows folder

AG_CHKPCNET

74

3,5

Check ATE network state

AG_CLIPBOARD

65

3

Perform clipboard operations

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

(none)

Run Delayed Operation in Background

AG_DESIGN

61

6

Design mode operations

AG_DIRCLEAN

114

4,5

Counts or deletes files based on various filter attributes.

AG_DISCONNECTPW

53

1

Set disconnect password

AG_DPM

110

(none)

Activate Windows "Dpi Per Monitor awareness

AG_DRAGDROP

112

4,5

Implements both destructive and non-destructive drag-drop modes

AG_EVENTWAIT

33

3

Event wait

AG_EVTMSG

57

(none)

Output system message

AG_FILESTATS

31

3,5

Get file stats

AG_FILETIMES

113

4,5

Get / set a file's modification, creation or access time

AG_FLASHWINDOW

28

(none)

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. Inquire if interested.

AG_GETDPI

111

3,5

Return the DPI for workstation and monitor

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_GETLOCALE

115

4,5

Retrieves the name of the user's locale on the client workstation.

AG_GETOFD

47

3,5

Display open/save file dialog

AG_GETSHELLPATH

71

3,5

Retrieve Windows path

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,5

Set / retrieve timeout period

AG_IMAGE

35

3

Image processing

AG_ISFOREGROUND

78

5

Test for foreground status

AG_MENU

21

3,5

Edit menu control

AG_MESSAGEBEEP

3

(none)

Play Windows sound

AG_MESSAGEBOXOK

4

3,5

Display OK / cancel message box

AG_MESSAGEBOXSTD

17

3,5

Display standard message dialog

AG_MINTITLE

1

(none)

Set minimized window title

AG_MKDIR

32

3,5

Make directory

AG_MOUSE

100

(none)

Set / Restore AutoMouse

AG_NEWPRODUCT

6

6

Allows override of certain info in the ABOUT box

AG_OPTIONS

69

4,5

Set / retrieve OPTIONS for ATE

AG_OSVER

66

3,5

Get OS info

AG_PALETTE

15

5

Query colors. See Define or Query Color Palette.

AG_PLAYSOUND

105

(none)

Play Sound File

AG_RAWDATA

83

1

Send raw data

AG_RELEASEKBD

49

1,3

Release ATE keyboard release

AG_RESETWINDOW

16

(none)

Reset window

AG_SAVERES

40

(none)

Save / restore screen with ID

AG_SBRFLAGS

102

3,4,5

Set / Retrieve SBR Flags

AG_SCROLLBACK

109

(none)

Control Scrollback Bar

AG_SENDKBD

82

(none)

Send keyboard characters

AG_SETCOLOR

15

(none)

Define or query color palette

AG_SETCURSOR

50

(none)

Set Mouse Cursor

AG_SETENV

77

3,4

Set environment variable

AG_SHLEXEC

24

3,5

Shell execute

AG_SHORTCUT

72

3,5

Create a shortcut

AG_SHOWFONT

99

(none)

Deprecated. Display font info.

AG_SHOWWINDOW

27

3

Show window

AG_SPOOLCFG

54

1

Auxiliary port control

AG_STATUSLINES

34

(none)

Enable / disable status lines

AG_SYSBCLR

26

3

Associate A-Shell and Windows colors

AG_SYSCOLOR

63

(none)

Change RGB Value

AG_TRACE

76

4,5

Clear / set / query ATE trace flags

AG_WALLPAPER

39

(none)

Display wallpaper

AG_WEBCACHE

108

3,5

Get / Set WEBCACHE Options

AG_WINEXEC

23

5

Execute Windows command line

AG_WINPTR

56

3,5

Display printer selection dialog

AG_WINSETTINGS

46

3,5

Get / set / load / save settings

AG_WINTITLE

2

(none)

Change the title that displays on the title bar of the A-Shell window

AG_WRAP

62

(none)

Enable / disable wrap

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

1Applies only to ATE. It may be technically possible to use the command in non-ATE situations, but it doesn’t make much sense.
2Requires 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).
3The 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.
4Similar 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.
5In 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).
6Used 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)

Set minimized window title

AG_WINTITLE

2

(none)

Change the title that displays on the title bar of the A-Shell window

AG_MESSAGEBEEP

3

(none)

Play Windows sound

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

AG_SETCOLOR

15

(none)

Define or query color palette

AG_PALETTE

15

5

Query colors. See Define or Query Color Palette.

AG_RESETWINDOW

16

(none)

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

AG_FTP

22

1,2,5

FTP

AG_WINEXEC

23

5

Execute Windows command line

AG_SHLEXEC

24

3,5

Shell execute

AG_XFUNC

25

5

Call SBX as a function (numeric)

AG_SYSBCLR

26

3

Associate A-Shell and Windows colors

AG_SHOWWINDOW

27

3

Show window

AG_FLASHWINDOW

28

(none)

Flash Window

AG_FTPSETPW

29

1,2

Set FTP login / password

AG_FILESTATS

31

3,5

Get file stats

AG_MKDIR

32

3,5

Make directory

AG_EVENTWAIT

33

3

Event wait

AG_STATUSLINES

34

(none)

Enable / disable status lines

AG_IMAGE

35

3

Image processing

AG_HOLDKBD

36

1, 6

Set ATE keyboard hold

AG_WALLPAPER

39

(none)

Display wallpaper

AG_SAVERES

40

(none)

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

AG_GETOFD

47

3,5

Display open/save file dialog

AG_RELEASEKBD

49

1,3

Release ATE keyboard release

AG_SETCURSOR

50

(none)

Set Mouse Cursor

AG_DISCONNECTPW

53

1

Set disconnect password

AG_SPOOLCFG

54

1

Auxiliary port control

AG_FTPSYNC

55

1,2

Used internally with ATSYNC.LIT. Inquire if interested.

AG_WINPTR

56

3,5

Display printer selection dialog

AG_EVTMSG

57

(none)

Output system message

AG_DESIGN

61

6

Design mode operations

AG_WRAP

62

(none)

Enable / disable wrap

AG_SYSCOLOR

63

(none)

Change RGB Value

AG_DATETIME

64

1,5

Retrieve ATE date and time

AG_CLIPBOARD

65

3

Perform clipboard operations

AG_OSVER

66

3,5

Get OS info

AG_ATTRSUB

68

(none)

Change underline attribute

AG_OPTIONS

69

4,5

Set / retrieve OPTIONS for ATE

AG_BROWSEFOLDER

70

3,5

Select Windows folder

AG_GETSHELLPATH

71

3,5

Retrieve Windows path

AG_SHORTCUT

72

3,5

Create a shortcut

AG_XFUNC2

73

(none)

Call SBX as a function (no return value)

AG_CHKPCNET

74

3,5

Check ATE network state

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

AG_ISFOREGROUND

78

5

Test for foreground status

AG_IATIMEOUT

79

1,3,5

Set / retrieve timeout period

AG_SENDKBD

82

(none)

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); see 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)

Set / Restore AutoMouse

AG_SBRFLAGS

102

3,4,5

Set / Retrieve SBR Flags

AG_PLAYSOUND

105

(none)

Play Sound File

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)

Run Delayed Operation in Background

AG_WEBCACHE

108

3,5

Get / Set WEBCACHE Options

AG_SCROLLBACK

109

(none)

Control Scrollback Bar

AG_DPM

110

(none)

Activate Windows "Dpi Per Monitor awareness

AG_GETDPI

111

3,5

Return the DPI for workstation and monitor

AG_DRAGDROP

112

4,5

Implements both destructive and non-destructive drag-drop modes

AG_FILETIMES

113

4,5

Get / set a file's modification, creation or access time

AG_DIRCLEAN

114

4,5

Counts or deletes files based on various filter attributes.

AG_GETLOCALE

115

4,5

Retrieves the name of the user's locale on the client workstation.