LockProvisional (NotesDocument - LotusScript®)

Defined in

NotesDocument

Syntax

flag = notesDocument .LockProvisional( [ name ] )

Parameters

name

Array of type String. Optional. The names of the lock holders. Each lock holder must be a user or group. Defaults to one lock holder: the effective user. The empty string ("") is not permitted in the array.

Return value

flag

Boolean.

• True if the lock is placed.
• False if the lock is not placed.

Usage

IsDocumentLockingEnabled in NotesDatabase must be True or this method raises an error.

The following actions occur depending on the current lock status:

• If the document is not locked, this method places the lock and returns True.
• If the document is locked and the current user is one of the lock holders, this method returns True.
• If the document is locked and the current user is not one of the lock holders, this method returns False.

If the document is modified by another user before the lock can be placed, this method raises an error.

Language cross-reference

lockProvisional method in Java™ Document class

Example