DisplayUnlockTypeDefinitionsDialog Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.DisplayUnlockTypeDefinitionsDialog ( typeDefinitions, allTypesUnlocked, dlgOptions = 0)

Return Value

Boolean

Returns True if any types were unlocked in the Unlock Type Definitions dialog box, even if not all types were successfully unlocked or if the user clicked OK and no types needed to be unlocked because all the types were already unlocked or were not password-protected.

Purpose

Displays the Unlock Type Definitions dialog box, in which you can unlock the specified types.

Remarks

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

typeDefinitions As Object Array

[In] Specifies an array of type definitions you want to unlock.

allTypesUnlocked As Boolean

[Out] Returns True if all the types you passed to the typeDefinitions parameter were successfully unlocked, already unlocked, or not password-protected.

dlgOptions As Long

[In] Specifies any combination of the LockUnlockDialogOptions constants.

This parameter has a default value of 0.


See Also

CommonDialogOptions

Engine.DisplayPasswordProtectTypeDefinitionsDialog

Password Protect Type Definitions dialog box

PropertyObject.GetTypeDefinitionProtection

PropertyObject.LockTypeDefinition

PropertyObject.SetTypeDefinitionProtection

PropertyObject.TypeDefinitionLocked

PropertyObject.UnlockTypeDefinition

ProtectedObjectOptions

Unlock Type Definitions dialog box

WAS THIS ARTICLE HELPFUL?

Not Helpful