Locks an agent provisionally.

Note This method is new with Release 6.

Defined in

NotesAgent

Syntax

flag = notesAgent.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.

flag

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

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

The following actions occur depending on the current lock status:

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

Language cross-reference

lockProvisional method in Java Agent class

Example
See Also

Locking documents and design elements

Glossary