Engine.DisplayLockUnlockDialog
- Updated2024-10-09
- 2 minute(s) read
Engine.DisplayLockUnlockDialog
Syntax
Engine.DisplayLockUnlockDialog( dlgTitle = "", dlgMsg = "", propObject = NULL, options = 0, [passwordString = NULL])
Return Value
Returns True if you click OK in the dialog box. Returns False if you click Cancel .
Purpose
Launches a dialog box in which you can lock or unlock a PropertyObjectFile, or prompt for a password to perform a lock or unlock operation.
Parameters
dlgTitle As String
[In] Specifies the title of the dialog box. Pass an empty string to use the default title for the dialog box.
This parameter has a default value of "" .
dlgMsg As String
[In] Specifies the message in the dialog box. Pass an empty string to use the default message for the dialog box.
This parameter has a default value of "" .
propObject As PropertyObject
[In] Specifies an object to lock or unlock. The object lock state determines whether the dialog box performs a lock or unlock operation by calling the PropertyObjectFile.Lock and PropertyObjectFile.Unlock methods respectively.
When you pass NULL , the dialog box does not operate on any object. The options parameter specifies whether the dialog box performs a lock or unlock operation. If you pass NULL and perform an unlock operation, you must specify the required password using the passwordString parameter.
This parameter has a default value of NULL .
options As Long
[In] Specifies any combination of the LockUnlockDialogOptions constants.
This parameter has a default value of 0 .
passwordString As Variant
[In/Out] [ Optional ] Specifies the password the dialog box expects when you specify LockUnlockDialogOption_Unlock in the options parameter, and returns the entered password from the dialog box when you specify LockUnlockDialogOption_Lock in the options parameter.
This parameter has a default value of NULL .