Differences

This shows you the differences between two versions of the page.

--- AppleScript [2017/10/04 06:52] – [Examples] peternlewis
+++ AppleScript [2025/02/27 06:45] (current) – [Local & Instance Variables] peternlewis
@@ Line 1: / Line 1: @@
 ====== Using AppleScript to Get and Set Keyboard Maestro Variables ======
-===== Get and Set Variables =====
 Keyboard Maestro Version 7.1 introduced a streamlined way to Get and Set Keyboard Maestro Variables from AppleScript.
-In AppleScript, you can tell the application "Keyboard Maestro Engine" to:
+In AppleScript, you can access Keyboard Maestro variables like this:
-    getvariable <KM Variable Name>
+```applescript
-    setvariable <KM Variable Name> to <New Value>
+tell application "Keyboard Maestro Engine"
+    set v to getvariable "<KM Variable Name>"
+    setvariable "<KM Variable Name>" to "<New Value>"
+end tell
+```
 where both the `<KM Variable Name>` and `<New Value>` are text values.
-==== Examples ====
+**For more details, see:**
+  - [[manual:Scripting|Scripting article in the Manual Section]].
+  - [[action:Execute_an_AppleScript|Execute AppleScript Action]].
+===== Global Variables =====
+Global Variables (available in //all// macros) may be got and set like this:
 ```applescript
@@ Line 44: / Line 52: @@
 ```
+**Real-World Example**
 Normally, you would not have both a GET and a SET variable within the same AppleScript tell block.\\
@@ Line 50: / Line 58: @@
 ```applescript
+### Requires Keyboard Maestro 7.1+ ###
 --- GET REQUIRED KM VARIABLES ---
@@ Line 67: / Line 77: @@
 ```
-To get or set local or instance variables, you must pass the macro execution instance to the `getvariable` or `setvariable` command.  The instance is passed in to your script via the KMINSTANCE environment variable (v8.0.3+).
+===== Local & Instance Variables =====
+To get or set [[manual:Variables#Scope|Local or Instance Variables]], you must pass the macro execution instance to the `getvariable` or `setvariable` command.  The instance is passed in to your script via the KMINSTANCE environment variable (v8.0.3+).
 ```applescript
-set inst to system attribute "KMINSTANCE"
+set kmInst to system attribute "KMINSTANCE"
 tell application "Keyboard Maestro Engine"
-	set v to getvariable "LocalVar" instance inst
+	set v to getvariable "Local__SomeLocalVariable" instance kmInst
-	setvariable "LocalOut" instance inst to "FromAS"
+	setvariable "Local__FromAS" instance kmInst to "Variable set in AppleScript."
 end tell
-v
+log v
 ```
-**For more details, see [[manual:Scripting|Scripting article in the Manual Section]].**
-===== Get and Set Dictionary Values =====
-You can read and write dictionary values from AppleScript.
+===== Dictionary Values =====
-```applescript
+You can read and write [[manual:Dictionaries|Dictionary]] values from AppleScript.
-tell application "Keyboard Maestro Engine"
-	name of dictionaries
-end tell
-```
 ```applescript
+### Requires Keyboard Maestro 8.0+ ###
 tell application "Keyboard Maestro Engine"
-	dictionary keys of dictionary "First Names"
+	set kmDictList to name of dictionaries
-end tell
+	set dictKeyList to dictionary keys of dictionary "First Names"
-```
-```applescript
-tell application "Keyboard Maestro Engine"
 	set value of dictionary key "P" of dictionary "First Names" to "Fred"
 end tell