Lock Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

PropertyObjectFile.Lock ( [passwordString])

Purpose

Locks the file. The PropertyObjectFile.Protection property specifies the type of protection for the lock. After reading a protected file, TestStand automatically locks the file. Use the PropertyObjectFile.Unlock method to unlock the file.

Remarks

This method applies only to sequence files. Using this method on other files causes an error. Locking a file causes an error when the PropertyObjectFile.Protection property is set to ProtectedObjectOption_None.

Note  TestStand supports password protecting sequence files to discourage editing and viewing within the sequence editor and user interfaces that use the TestStand User Interface (UI) Controls. The TestStand API limits access to a file protected from viewing but cannot prevent access to the file content during execution. National Instruments does not recommend using passwords as the only way of protecting intellectual property.

Parameters

passwordString As Variant

[In] [Optional] Specifies the password for the lock operation. If no passwordString parameter is specified, the previous password is used. If no previous password was specified, the password is an empty string.


See Also

Omitting Optional Parameters

PropertyObjectFile.Locked

PropertyObjectFile.Protection

PropertyObjectFile.Unlock

ProtectedObjectOptions

WAS THIS ARTICLE HELPFUL?

Not Helpful