VI class/Lock State.Set method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 3FE
Scope Basic Development Environment
Data Name Lock State.Set
Short Name* Lock State.Set
Long Name* Lock State:Set
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 2
Owning Class Name VI Class
Return Data Type No return value
Invoke Node Lock State:Set
Available in Real-Time Operating SystemYes
Available in Run-Time EngineNo
Available with control VIsYes
Available with global VIsYes
Available with polymorphic VIsYes
Available with strict type definitionsNo
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Must wait until user interface is idleYes
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningYes

Sets the lock state of a VI. If interactive is FALSE (default), you can use password to either unlock a password-protected VI or set the password of an unprotected VI. If interactive is TRUE, LabVIEW ignores password and displays a dialog box that prompts you to change the lock state.

This method is similar to the Unlocked (no password), Locked (no password), and Password-protected options on the Protection page of the VI Properties dialog box.


Data type Name Required Description
Enum U32 Lock State Yes Specifies the level of editing permission of the VI.
Boolean Interactive No Specifies whether to display a dialog box that prompts you to change the lock state. The default is FALSE.
String Password No If lock state is Password-protected, password is the new password. If you are changing lock state from Password-protected, password is the old password. The default is an empty string.
Boolean Put in Cache No If Lock State is Password-protected, Put in Cache specifies whether to place the new password in the cache. The default is FALSE.



Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links