GSAK (Geocaching Swiss Army Knife)
Contents - Index

$_RunMode

The system variable $_RunMode contains the context or "mode" the macro is running. Possible modes are:

Symbol - The macro is used to generate GPSr like symbols. For example when you take this option:



MacroTag - The macro is being called via the special tag %Macro

Mtag - The macro is being called via the special tag %mtag

GpxLoad - The macro is being called via GPX load:



ShowOffline - The macro is being called via the waypoint right mouse click "Show offline" option

CommandLineRun - The macro is being called via the command line (invoking GSAK using the /run parameter)

CustomHtml - The macro is being run as the result of a custom HTML format

MacroManager - The macro is being run from the Macro manager dialog

ToolBar - The macro is being run from one of the tool bar buttons

DbOpen - The macro is being run from "Database=>Properties"



MacroCommand - The macro is being run from another macro (by using the "Macro" command (also see notes at end)

URI - The macro is being called via URI support

PublishLogsEach - Macro is being called via publish logs (for each log)

PublishLogsAll - Macro is being called via publish logs (after all logs published)

MacroEditor - Macro is being called directly from the macro editor

OnStartUp - The macro is being called as a config Start up macro (see "Tools=>options=>advanced")

OnExit - The macro is being called as a config exit macro (see "Tools=>options=>advanced")

MapMacro - The macro is being called as a result of right mouse click on the GSAK google map and selecting the option "Run map macro". The actual macro to run is configured via "Tools=>options=>advanced=>page2=>Google maps macro"

Corrected - The macro is being run as a result of defining a macro to run after entering corrected coordinates (see "Waypoint=>Corrected coordinates")

Notes: All values will have an appending ; (semi colon). This is because that when a macro is run there could be more than one mode possible. For example, let us say you have a start up macro called "start.gsk" that calls macro "xxx.gsk"

If you interrogate the system variable in the macro "start.gsk" the value will be:

OnStartUp;

If you interrogate the system variable in the macro "xxx.gsk" the value will be:

OnStartUp;MacroCommand;
Copyright 2004-2014 CWE Computer Services  
Privacy Policy Contact