Function

====== Handles.SetLockState ======

  Void Handles.SetLockState(LockStates state)

^ API | http://api.avolites.com/11.0/Handles.SetLockState.html |
^ description | Set the lock state of a handle |
^ [[macros:namespace|namespace]] | [[macros:namespace:handles]] |
^ parameter | state ( [[macros:type:enum]] ) : "Unlocked", "TransparentLocked" or "FullyLocked" |
^ return value | [[macros:type:void]] |
^ affects | [[macros:property:handles.sourcehandle]] |

== Example in == 
[[macros:example:setplaybacklockstate|]]

<code xml>
  <step>Handles.SetSourceHandle("PlaybackWindow", 0)</step>
  <step>ActionScript.SetProperty.Enum("Handles.SourceHandle.LockState", "FullyLocked")</step>
  <step>Handles.SetLockState(Handles.SourceHandle.LockState)</step>
</code>

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>.}}

~~DISCUSSION~~