HCL Domino - Lock method - Need a Domino Consultant? Call NotesMail +1 212-599-2048

HCLSoftware Business Partner Domino Consulting Services CRUCIAL Notes Tools +1 212-599-2048	Domino Consulting Services CRUCIAL Notes Tools Domino administration Notes development	Chat now
.

Need a Domino Consultant? Call NotesMail +1 212-599-2048 - HCLSoftware Business Partner

LOTUSSCRIPT/COM/OLE CLASSES

Lock method
Example

Locks a document.

Note This method is new with Release 6.

Defined in

NotesDocument

Syntax

flag = notesDocument.Lock( [ name ] [, provisionalOK ] )

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

. The empty string ("") is not permitted in the array.

provisionalOK

Boolean. Optional.

Return value

flag

Boolean.

Usage

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

This method:

Places a persistent lock if the administration (master lock) server is available.
Places a provisional lock if the administration server is not available and the second parameter is True.
Raises an error if the administration server is not available and the second parameter is False.

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

lock method in Java Document class

@DocLock function in formula language

Example
See Also

Feedback on Help or Product Usability?

Feedback on Help or Usability?