GSAK (Geocaching Swiss Army Knife)
Contents - Index

Command/Functions by Category 

Jump to: Alpha List   database variables   system variables   Forms

Database/Waypoint
Date/Time
Filesystem
Geocaching.com Access
Internet
Macro Language
Mathematical/Numeric
Miscellaneous
String Manipulation
User Input/Forms

Database/Waypoints 
   
AddNew          Add a new record to a table
CacheMate       Load CacheMate logs and finds from a CM2GPX generated file
CancelFilter    Cancel the current filter
CodeMatch      Optimized database code matching
CustomConfig            Configure custom fields in the database
CustomGet            Get the contents of any custom field
CustomPut            Update the contents of any custom field
Database        Select, create, delete a database
DatabaseExists  Test to see if a GSAK database exists
DataRestore     Restore saved database fields
DataSave        Save database fields
Delete          Delete waypoint(s) from the current database
Elevation           Automatic conversion of elevation as per user's settings
Export          Export any of the GSAK supported file types
Filter          Select a saved filter
GarminApi           Get data from Garmin Opencaching.com using API
GlobalReplace         Global replace of data fields
GetCountry           Get the country name of a waypoint
GetCounty           Get the county name of a waypoint
GetNear           Get a list of the nearest waypoints to a given coordinate
GetPolygon           Determine if a waypoint lies inside a polygon
GetState           Get the state name of a waypoint
GoTo            Position the current waypoint in the grid
Grab            Grab coordinates adding waypoints to current database
IsOwner           Ownership of the current cache or log
Load            Load a GPX/loc/zip file into the database (or folder of these files)
MacroDelete         Delete records from Caches, Waypoints, or Logs
MacroFlag       Set/Clear macro flags
MFilter         "On the fly" macro filter
MoveCopy        Move or Copy waypoints from one database to another
PurgeLogs       Purge out required log records from a database
PurgeNote       Purge/delete out details from user notes
RestoreFilter   Restore filters settings saved by SaveFilter
ReSync          Resynchronize database after direct Sqlite update
ReSyncLogs         Resynchronize your logs with the GSAK database
SaveFilter      Save filter settings to restore later with RestoreFilter function
Seek            Quickly position or find a code
SetColor        Set colors for rows or columns
SQLGet             Optimized fetch of data from Sqlite tables
SQLGetClose       Manually close a table opened for reading by SqlGet()
SQLNext       Read the next row for SqlGet()
SQLQuote             Prepare SQL strings with escaped quotes
SQLite             Portal to the feature rich SQLite SQL database engine
SQLSort       Sort grid using SQL OrderBy
SqlToHtml       A quick and easy way to view SQL data
Table           Select the active table (Caches, Logs, Waypoints)
TotChild        Get the total number of child waypoints
Transaction           Speed up Database variable updates)
UpdateElevation        Update elevation
UserFlag        Set/Clear user flags
UserSort        Get or set user sort config values
View            Select a GSAK grid view


Date and Time 
   
DateDiff        Find the number of days between two dates
DateFormat      Convert a date to string using current system date settings
DateToSQL      Convert a date to SQL date format
DateToString    Reverse of the StringToDate function
SQLToDate      Convert a SQL date string to a macro date
StringToDate    Convert a string literal to a date type variable
Time            Returns the system time as a string in the form HH:MM:SS
ValidDate             Test if valid date


FileSystem
    
Appendfile   Append data to an existing file
Dir      Directory/Folder listing
DriveExists             Test if a drive is exists and is ready for use
EndRead         See the FileRead command
FileCopy        Copy a file
FileErase       Erase file(s)
FileExists Test if file exists in fully qualified path
FileOpen  Open a file
FileRead        Read a text file line by line
FolderExists    Test if a folder/directory exists
GetFile         Read the contents of a disk file
PutFile         Write a file to disk
StopRead        Terminate FILEREAD
TextOut         Generate CSV and tab delimited text files
ZipFile        Zip File zip/unzip support



Geocaching.com Access
 
GcApi        Groundspeak live api
GcBalance           Get api cache balance
GcFavPoints        Macro equivalent of Geocaching.com access=>Favorite points
GcGetCaches          Macro equivalent of Geocaching.com access=>Get caches
GcGetLogs          Macro equivalent of Geocaching.com access=>Get logs
GcGetNewToken          Macro equivalent of Geocaching.com access=>Get another access token
GcGetPQ          Macro equivalent of Geocaching.com access=>Download pocket queries
GcPublishFetch          Macro command to fetch logs for publishing
GcRefresh          Macro equivalent of Geocaching.com access=>Refresh cache data
GcStatusCheck          Macro equivalent of Geocaching.com access=>Status check
GcSwapToken          Swap Geocaching.com api accounts via a macro
GcUpdateUserInfo          Macro equivalent of Geocaching.com access=>Update user information



Miscellaneous
   
Backup          Backup GSAK databases(s) and settings
BBcode          Convert BBcode to HTML
CacheType           Return 1 letter, expanded, and lists of  cache type names
ChildType           Return a list of child waypoint types
Centre          Set the current centre point
Clip            Copy information to the windows clipboard
CustomFormat            Create custom HTML formats
Dualscreen           Turn on/off the dual screen display
GetClipText           Get the current clipboard text
GetSil           Translation master access
GetEnvV         Get value of a system environment variable
GPSInfo           Get GPS information
GPSReceive           Receive waypoints from your GPSr
GrabImages          Grab images from online links in cache description
GsCodeToNum           Get the ID number of a GCXXXXX code
ImageInfo             Get information about an image file
MacroSet        Update dialog settings from within a macro
MacSettings         Save/Restore macro settings
MakeGGZ        Create a Garmin format GGZ file from one or more GPX files
MakeTranslation        Create a translation master for use in macros that support multiple languages
NumToGsCode           Get the GCXXXX code from an ID number
PlayWav         Play a WAV sound file
RefreshCustomHtml          Refresh custom HTML formats list
RGBColor       Convert RGB color values to a number to use in SetColor command
Restore          Restore GSAK databases(s) and settings
RunPgm          Run any external program
SplitScreen     Turn on/off split screen display
SysInfo         Retrieve system information
SysVarPath         Convert an asolute path to a GSAK system variable
Timer           Macro stopwatch
Translate        Translate English strings to user's current language
XmlToSqlite           XML reader - by converting a XML file to a Sqlite table


Internet 
   
GetMail         Allows you to download attachments from a POP3 mail account
GarminApi           Get data from Garmin Opencaching.com using API
GetUrl           Get the contents of a URL
PostUrl       Fetch a URL and submit "post" data
Web             Run any URL and show in current browser


Macro Language
    
BeginCase        Begin a group of CASE statements
BeginSub        Begin a subroutine
Break           Exit out of the current WHILE loop
BreakRepeat           Exit out of the current Repeat loop
Cancel          Cancel the macro and return to the GSAK GUI
Case        CASE statements
Debug           Debug a macro script
Declare          Declare a variable
Deprecated          Remove deprecated warning message
Else            Execute statements for the false condition of an IF command
EndSub          End a subroutine
Exit            Exit GSAK (not just the macro but the whole program)
ExitSub         Exit a subroutine
Delay           Delay the running of a macro by milli seconds
GoSub           Call a subroutine
If              Run macro commands only if a certain condition exists
Include         Insert a code file into a macro
MacHeader           Retrieve the contents of the header parts of a macro
Macro           Run another macro
NoError         Allow code to run under multiple versions of GSAK
Not         Negate a boolean expression
Option          Request explicit declaration of variables or not
PreProcess            Interrogate the status of the Shift and Ctrl keys and macro start up)
RemoveVar        Remove a macro variable from memory
Repeat           Repeat macro statements until a certain condition exists (looping)
Return          Exit the current macro file only
SpeedMode       Turns macro speed mode on or off
UpdateCheck        Macro version check
VarExists        Test for existence of a variable
VerCheck       Check GSAK version macro can run under
Vsub            Toggle variable substitution on and off
While           Run macro commands while a certain condition exists (looping)
InTransaction             See if Sqlite transaction is already running


Mathematical/Numeric 
     
AbsReturns an absolute value of a number
ArcCos          Calculates the inverse cosine of a given number
ArcCosh         Calculates the inverse hyperbolic cosine of a given number
ArcSin          Calculates the inverse sine of a given number
ArcSinh         Calculates the inverse hyperbolic sine of a given number
ArcTan          Calculates the arctangent of a given number
ArcTan2         Calculates the arctangent angle and quadrant of a given number
ArcTanh         Calculates the inverse hyperbolic tangent of a given number
Cos             Calculates the cosine of an angle
Cosh            Calculates the hyperbolic cosine of an angle
Cotan            Calculates the cotangent of an angle
DegToRad           Convert angles expressed in degrees to the corresponding value in radians
Exp             Exp returns the value of e raised to the power of X
Frac            Get the fractional part of a number
GCalc           Calculations using longitude and latitude
Int             Get the integer portion of a number
Ln              Get the natural logarithm of a number (Ln(e) = 1)
Log             Get log base n of a number
NumToStr        Convert a number value to a string value
Random         Generate a random number
RadToDeg           Convert angles measured in radians to degrees
Round           Round a number to N decimal places
Sin             Calculates the sine of the angle in radians
Sinh            Returns the hyperbolic sine of an angle
Sqr             Returns the square of a number
Sqrt            Returns the square root of a number
Str             Converts a number into a right justified string with decimals digits following the decimal point
Tan             Calculates the tangent
Tanh            Calculates the hyperbolic tangent
Val             Convert a string to a number


String Manipulation 
    
AddStrOptimized/fast string concatenation
AlltrimRemove spaces before and after a string
ArrayArray function for array support
Asc             Return the ascii value of a character
At              Get the position of string found in another string
AtStart        Get the position of a string found in another string, from a specified start position
BoolToStr        Convert Boolean value to a string
Chr             Convert a decimal value to its ASCII equivalent
CsvGet            Extract CSV data from a string
EntityDecode        Decode XML entities to a single character
Equal            Test two strings to see if they are equal
Eval            Evaluate/convert a string with special tags
Extract         Extract part of a string from another given a delimiter
HttpEncode             HttpEncode a string
IsEmpty         Test if a string is empty
Keep           Convert a string by keeping only required characters or data in a string
Left            Get the left most characters of a string
Len             Get the length of a string
List            Manipulate lists (Array like support)
Lower           Convert a string to all lower case
MimeDecode      Mime decode a string
MimeEncode      Mime encode a string
NumToStr        Convert a number value to a string value
Quote           Enclose a string in double quotes
RegEx           Use a regular expression to find a string in another string
RegExCount      Count the number of times a regular expression is found in a string
RegExData       Return the matching data of a regular expression
RegExEscape     Escape data so can search as plain text
RegExPos     Find the matching position of a regular expression in a string
RegExReplace    Replace matching regular expression with a string
RegExSub        Retrieve the matching sub expression
Remove           Convert a string by removing required characters or data
Replace         Replace one string with another
Right          Get the right most characters of a string
ROT13        ROT13 encode/decode a string
SlashAdd       Make a folder path end with a back slash
SmartName       Calculate a "smart name" for any string
StrToBool        Convert a string value to Boolean
SubStr          Get a sub string from a string
Trim            Removes trailing spaces from a string expression
Upper           Convert a string to all uppercase
UTF8        UTF8 encode/decode a string
UTF16        UTF16 encode/decode a string
Val             Convert a string to a number
<Data>          Static allocation of large text to a variable

  
User input and forms 
   
Choose          Select from a list of choices
Editform        Edit a GSAK form
Form        Show a GSAK form
Input           Prompt user for data and assign to a variable
MsgOK         Simple message box with single OK button
Pause           Pause the macro (with message)
ShowStatus      Show the status of a macro command
ShowStop        Show a stop dialog when running a macro so you can cancel the macro at any time
YesNo         Quick display of a Yes/No dialog

Copyright 2004-2014 CWE Computer Services  
Privacy Policy Contact