Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

updateProjectLock

Synopsis

boolean updateProjectLock(
    string sessionId,
    LockingMode lockMode
)

See also: LockingMode

Used to update the lock of the session’s current project. The actual operation and the meaning of the return values depends on the locking mode:

  • Default - query the state of the lock, i.e. whether or not the project holds the lock; returns true if the project holds the lock

  • NoLock - release the lock if it is held by the project; returns true if the project previously held the lock

  • TryLock - try to lock the project; returns true if the lock could be acquired (or was already held by the project), false otherwise

  • Lock - like TryLock, but fails with an exception instead of returning false

  • ForceLock - always lock the project, stealing the lock from the current lock holder if necessary

Note that the return value does reflect the state of the lock at some point during the execution of the operation. In particular, a return value of true in case of *Lock does not necessarily that the project still holds the lock when the operation returns (someone else may have stolen it in the meantime).

Increased project lock timeout from 5 to 10 minutes, and refresh timeout from 3 to 5 minutes.