PropertyObject.UnlockTypeDefinition

Syntax

PropertyObject.UnlockTypeDefinition( passwordString)

Purpose

Changes the in-memory state of a password-protected type definition to unlocked. The password you pass for the passwordString parameter must match the password set for the type definition or this method returns an error, even if the type is already in an unlocked state. This method also returns an error if you call it on a type that is not password-protected.

Remarks

You can call this method on any property of the type definition, not just the root object of the type.

Note TestStand supports password-protecting type definitions to deter unauthorized users from editing the types in the sequence editor. However, any TestStand user can continue to programmatically edit a locked type by using the TestStand PropertyObject API. National Instruments does not recommend password-protecting types as the only way of protecting intellectual property.

Parameters

passwordString As String

[In] Specifies the password required to unlock the type.

See Also

Engine.DisplayPasswordProtectTypeDefinitionsDialog

Engine.DisplayUnlockTypeDefinitionsDialog

Password Protect Type Definitions dialog box

PropertyObject.ClearTypeDefinitionPasswordHistory

PropertyObject.GetTypeDefinitionProtection

PropertyObject.LockTypeDefinition

PropertyObject.SetTypeDefinitionProtection

PropertyObject.TypeDefinitionLocked

ProtectedObjectOptions

Thread Safety of the PropertyObject API and TestStand Variables