RemoveLock

(Control Lock Manager)

Description:	Removes a Control Lock from a tag.
Warning	This statement is recommended for advanced users only.
Returns:	Nothing
Usage:	Script Only.
Function Groups:	(Control Lock Manager)
Related to:	AddLock | CanAddLock | CanControl (Control Lock Manager) | CanRemoveLock | GetLockLevel | RemoveLock |
Format:	\ControlLockManager.RemoveLock(TagID, LockGUID[, Note, Custom, Timestamp, SessionID, AccountID, MachineID, Device, Auto])
Parameters:

TagID

Required text. The unique ID of tag from which to remove the lock.

LockGUID

Required text. The lock record GUID of the lock. To find the lock record use a statement such as AlarmManager.GetAlarmList(...). RemoveLock is not not designed to be user-friendly. Most users should use the 'Remove' button in the Alarm List widget.

Note

Optional text. A note to log following the release operation.

Custom

Optional. A structure of custom fields to log.

Timestamp

Optional timestamp. UTC timestamp of this event. Defaults to current time.

SessionID

Optional text. The ID of the session where this function was called. Defaults to the current security session.

AccountID

Optional text. The AccountID of the user removing the lock. Defaults to the user signed in at the station where this function is called.

MachineID

Optional text. The workstation's MachineID. Defaults to the workstation from which this function is called.

Device

Optional text. The name of the client device.

Auto

Optional Boolean. Set true for automatic lock removal.

Comments:

None

Example:

None available.