Locks, unlocks, returns the locked status of the current document, or indicates if a database has document locking enabled.

Note This @function is new with Release 6.

Syntax

@DocLock ( [ options ] )

Parameters

[ options ]

Keyword. Choose one of the following actions:

[LOCK]


Locks the current document.

[UNLOCK]

Unlocks the current document.

[STATUS]

Indicates the locked status of the current document. Returns null if the document is not locked or a textlist of the users who have locked the document if it is locked.

[LOCKINGENABLED]

Indicates if the current database has document locking enabled. Returns 1 (@True) if locking is enabled and 0 if it is not.

The current document has to have been saved previously for this function to work properly. The document must be in Read mode when this function is triggered. Additionally, document locking must be enabled for the database or you will get the error, "Attempted a lock operation on a DB that doesn't support locking" when you try to use the [LOCK], [STATUS], or [UNLOCK] keywords.

To enable document locking:

1. Specify a Lotus Domino server as the Administration Server (Master Lock Server) on the Advanced panel of the Access Control List dialog box for the database.

2. Select the Allow Document Locking check box on the Database Basics tab of the Database Properties box.

You cannot use this function in Web applications.

Language cross-reference

Lock method of LotusScript NotesDocument class

LockHolders property of LotusScript NotesDocument class

Unlock method of LotusScript NotesDocument class

Example

Glossary