IAFTransactable.UndoCheckOut Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
This method discards all the changes to the object and all sub-objects since the
last call to CheckOut. Any changes since the check out will be lost.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
void UndoCheckOut( bool force )
Sub UndoCheckOut ( force As Boolean ) Dim instance As IAFTransactable Dim force As Boolean instance.UndoCheckOut(force)
void UndoCheckOut( bool force )
abstract UndoCheckOut : force : bool -> unit
Parameters
- force
- Type: SystemBoolean
If this parameter is , then the check out is undone even if the object has been checked out by another user. If , then only the user that checked out the object is allowed to undo the check out.
Events
| Event Type | Reason |
|---|---|
| IAFChangedEventChanged | This event will be raised for each object updated by this method call. |
Remarks
All changes since the last call to CheckOut will be discarded including
changes previously applied using the ApplyChanges method.
A check out can only be undone by the user who currently has the object checked out
unless the force parameter is set to .