Differences

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

--- macros:function:handles.setlockstate [2018/08/26 16:05] – icke_siegen
+++ macros:function:handles.setlockstate [2019/05/04 16:14] (current) – icke_siegen
@@ Line 2: / Line 2: @@
 ====== Handles.SetLockState ======
- <fs xx-large>This is based on the API function but does actually not work!</fs>
   Void Handles.SetLockState(LockStates state)
@@ Line 10: / Line 8: @@
 ^ description | Set the lock state of a handle |
 ^ [[macros:namespace|namespace]] | [[macros:namespace:handles]] |
-^ parameter | state ( [[macros:type:LockStates]] ) : "Unlocked", "TransparentLocked" or "FullyLocked" |
+^ parameter | state ( [[macros:type:enum]] ) : "Unlocked", "TransparentLocked" or "FullyLocked" |
 ^ return value | [[macros:type:void]] |
 ^ affects | [[macros:property:handles.sourcehandle]] |
 == Example in ==
-[[macros:example:createworkspaces]]:
+[[macros:example:setplaybacklockstate|]]
 <code xml>
-  <step>Handles.SetSourceHandle("Playbacks", 0)</step>
+  <step>Handles.SetSourceHandle("PlaybackWindow", 0)</step>
-  <step>Handles.SetLockState(TransparentLocked)</step>
+  <step>ActionScript.SetProperty.Enum("Handles.SourceHandle.LockState", "FullyLocked")</step>
+  <step>Handles.SetLockState(Handles.SourceHandle.LockState)</step>
 </code>
-Puts a transparent lock on handle #1 of the current playbacks page.
+Puts a lock on handle #1 of the current playbacks page.
+Please note that the function expects an enum passed. See [[macros:example:setplaybacklockstate|]] for examples how to do this.
 == Also used in ==
 {{backlinks>.}}
-== Remarks ==
 ~~DISCUSSION~~