Differences

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

--- AppleScript [2017/06/04 19:06]
JMichaelTX [Get Existing Variable]
+++ AppleScript [2017/10/04 02:52]
peternlewis [Examples]
@@ Line 1: / Line 1: @@
 ====== Using AppleScript to Get and Set Keyboard Maestro Variables ======
-\\
 ===== Get and Set Variables =====
@@ Line 67: / Line 67: @@
 ```
+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+).
+```applescript
+set inst to system attribute "KMINSTANCE"
+tell application "Keyboard Maestro Engine"
+	set v to getvariable "LocalVar" instance inst
+	setvariable "LocalOut" instance inst to "FromAS"
+end tell
+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.
+```applescript
+tell application "Keyboard Maestro Engine"
+	name of dictionaries
+end tell
+```
+```applescript
+tell application "Keyboard Maestro Engine"
+	dictionary keys of dictionary "First Names"
+end tell
+```
+```applescript
+tell application "Keyboard Maestro Engine"
+	set value of dictionary key "P" of dictionary "First Names" to "Fred"
+end tell
+```
 ===== Prior to Ver 7.1 =====
@@ Line 77: / Line 106: @@
   * They present an alternate method.
-==== Create & Set Variable ====
+==== Set Variable ====
+(will be created if necessary)
 ```applescript
---- Requires KM 7.0.2+ ---
+my setKMVar("MY_KM_Variable", "some new value")
---- Set AppleScript Variables to KM Variable Name and Value ---
+on setKMVar(pKMVarNameStr, pValueStr)
-set myKMVar to "My KM Var Name"
-set myASVar to "My data"
+  --- Compatible with Keyboard Maestro 6+ ---
+  --     • Creates the KM Variable if does not exist (just like KM 7 setvariable)
+  --     • Returns true if new Variable was created
-tell application "Keyboard Maestro Engine"
-  if variable myKMVar exists then
+  set varCreatedBool to false
-    --- SET KM Variable ---
-    set value of variable myKMVar to myASVar
+  tell application "Keyboard Maestro Engine"
-  else
+    try
-    --- Create & Set KM Variable ---
+      set value of variable pKMVarNameStr to pValueStr
-    make new variable with properties {name:myKMVar, value:myASVar}
-  end if
+    on error errMsg number errNum
-end tell
+      if (errNum = -10006) then --- KM Variable Does NOT Exist ---
+        --- Create & Set KM Variable ---
+        make new variable with properties {name:pKMVarNameStr, value:pValueStr}
+        set varCreatedBool to true
+      else
+        error ("Error " & errNum & ":  " & errMsg)
+      end if
+      -- END on error
+    end try
+  end tell
+  return varCreatedBool
+end setKMVar
 ```
-==== Get Existing Variable ====
+==== Get Variable ====
+(returns empty string "" if Variable does //not// exist)
 ```applescript
@@ Line 107: / Line 155: @@
   --- Compatible with Keyboard Maestro 6+ ---
-  --     • Returns "" if variable is not found (just like KM 7)
+  --     • Returns "" if variable is not found (just like KM 7 getvariable)
   tell application "Keyboard Maestro Engine"

Keyboard Maestro Wiki

User Tools

Site Tools

Differences

Page Tools