For examples of how to use AREXX with Go Fetch!, please see included AREXX scripts.

AREXX PORT: GOFETCH

These returncodes apply to all Arexx Commands
-4 = Command received wrong number of parameters
-3 = Command received parameter of wrong type
-2 = Out of Memory (except where stated)

Command: addanonprofile
Parameters: SITE/A,PORT/A,REMOTEPATH/A,FILENAME/A,LOCALPATH/A
ReturnCodes: 0 = Success
Description:
Adds a new profile at the end of the profile queue in Go Fetch!. The profile is automatically saved. The profile will have the username anonymous and the password as the configured anonymous password in Go Fetch!.

Command: addprofile
Parameters: SITE/A,PORT/A,USERNAME/A,PASSWORD/A,REMOTEPATH/A,FILENAME/A,LOCALAPTH/A
ReturnCodes: 0 = success
Description:
Adds a new profile at the end of the profile queue in Go Fetch!. The profile is automatically saved.
(See: editprofile)

Command: addsite
Parameters: SITE/A
ReturnCodes: 0 = Success
-1 = Failed, could not open site directory file.
-2 = Failed, Add or Edit window was open.
Description:
Adds URL to the site directory. This cannot be done whilst the Add or Edit window is open.

Command: clearlog
Parameters: NONE
ReturnCodes: 0 = success
Description:
Clears the Go Fetch! log listview.

Command: deleteprofile
Parameters: PROFILE/N
ReturnCodes: 0 = success
-1 = Profile doesn't exist
Description:
Deletes the profile passed by the profile number. Please note that profiles are are numbered starting at 0. For example if there are 8 profiles in Go Fetch! then they are numbered from 0 to 7. Do not pass a negative profile number.
(See: profiles)

Command: editprofile
Parameters: PROFILE/N,SITE/A,PORT/A,USERNAME/A,PASSWORD/A,REMOTEPATH/A,FILENAME/A,LOCALAPTH/A
ReturnCodes: 0 = success
-1 = Profile doesn't exist.
Description:
Edits the profile with the new specified values. Please note that the profiles are numbered starting at 0. For example, if there are 8 profiles in Go Fetch!, they will be numbered from 0 to 7. Under no circumstances should you pass a negative profile number for editing, this will have unpredictable effects. The profile is automatically saved and the profile listview is automatically updated to reflect the changes.
(See: profiles, addprofile)

Command: getanon
Parameters: NONE
ReturnCodes: 0 = success
ReturnString: Default Anonymous Password
Description:
Returns the default anonymous password as a string, which is set in the program tool types, if the user has not set a password then it will return
nobody@nobody.com

Command: getdownloadpath
Parameters: NONE
ReturnCodes: 0 = success
ReturnString: Default Download Directory
Description:
Returns the default download directory as a string, which is set in the program tool types, if the user has not set a default download directory then it will return ram:

Command: gofetch
Parameters: NONE
ReturnCodes: 0 = Success
Description:
Simulates the GO button. Go Fetch! will start downloading files and working through the profiles.

Command: iconify
Parameters: NONE
ReturnCodes: 0 = success
Description:
Iconifies Go Fetch!
(See: uniconify, iconifystatus)

Command: iconifystatus
Parameres: NONE
ReturnCodes: 0 = uniconified
1 = iconified
Description:
Returns whether Go Fetch is iconified.
(See: iconify, uniconify)

Command: lockgui
Parameters: NONE
ReturnCodes: 0 = success
Description:
Locks the Go Fetch! main window from receiving user input. This command is nested, therefore if you tell the window to lock twice, you must also tell it to unlock twice. USE WITH CAUTION.
(See: unlockgui)

Command: openaddwindow
Parameters: NONE
ReturnCodes: 0 = success
Description:
Opens the profile add window, simulates the user pressing the ADD button.

Command: openeditwindow
Parameters: NONE
ReturnCodes: 0 = success
Description:
Opens the edit window, simulates the user pressing the EDIT button. Please note that the edit window will not open if a profile isn't active. This command will return 0 regardless of whether the edit window opened or not.
(See: setactiveprofile, profiles)

Command: profiles
Parameters: NONE
ReturnCodes: Number of Profiles
Description:
Returns the number of profiles in Go Fetch!. For example, if there are 8 profiles in Go Fetch!, then this command will return 8.

Command: quitgofetch
Parameters: NONE
ReturnCodes: 0 = success
Description:
Quits Go Fetch!

Command: release
Parameters: NONE
ReturnCodes: Release Number
Description:
Returns the release number of Go Fetch!. Each public release of Go Fetch! will have it's release number incremented by 1, independant of the program version.

Command: reloadprofiles
Parameters: NONE
ReturnCodes: 0 = success
Description:
Forces Go Fetch! to reload the profiles from the profiles file. This has no real practical use because Go Fetch! automatically updates the profiles whenever an addition or edit is made. This command may be useful to those who feel confident enough to edit the profiles file directly, however this is highly unadvised as an invalid profiles file may have unpredictable effects in Go Fetch!

Command: savelog
Parameters: PATH/A
ReturnCodes: 0 = success
-1 = Unable to save logfile. Check your path.
Description:
Saves the Go Fetch! log with a filename of gofetch.log at the chosen path.

Command: setactiveprofile
Parameters: PROFILE/N
ReturnCodes: 0 = success
-1 = Profile doesn't exist
Description:
Highlights the profile entry in the profile listview passed by the profile number. Please note that profiles are numbered starting at 0. For example if there are 8 profiles in Go Fetch! then they are numbered from 0 to 7. Do not pass a negative profile number.
(See: profiles)

Command: stop
Parameters: NONE
ReturnCodes: 0 = success
Description:
Aborts the current file transfer, and stop Go Fetch! from moving onto the next profile.

Command: uninconify
Parameters: NONE
ReturnCodes: 0 = success
Description:
Uniconifies Go Fetch!
(See: iconify)

Command: unlockgui
Parameters: NONE
ReturnCodes: 0 = success
Description:
Unlocks the Go Fetch! main window to allow user input after the lockgui command has been issued. This command is nested, therefore if you tell the window to lock twice, you must also tell it to unlock twice.
(See: lockgui)

Command: windowopen
Parameters: NONE
ReturnCodes: 0 = No Windows Open
1 = Add Window Open
2 = Edit Window Open
Description:
Returns whether any windows are currently open (Add, Edit).

Command: HELP
Parameters: FILE/A
ReturnCodes: 0 = success
Description:
Lists GO Fetch Arexx Commands into the file specified.

Command: HIDE
Parameters: NONE
ReturnCodes: 0 = success
Description:
Iconifies Go Fetch!

Command: INFO
Parameters: ITEM/A
ReturnCodes: 0 = success
Returns requested string in result.
Description:
Where ITEM is:
TITLE = Title of Application
AUTHOR = Author of Application
COPYRIGHT = Copyright Message
DESCRIPTION = Description of Go Fetch
VERSION = Current Version
BASE = Name of AREXX Port
SCREEN = Name of public screen

Command: QUIT
Parameters: NONE
ReturnCodes: 0 = success
Description:
Quits Go Fetch!

Command: SHOW
Parameters: NONE
ReturnCodes: 0 = success
Description:
Uniconfies Go Fetch!