AFEventFrame.CheckIn Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
This method checks in (commits) all the changes to the object by saving
the information to persistent storage.
Namespace: OSIsoft.AF.EventFrame
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public void CheckIn()
Public Sub CheckIn Dim instance As AFEventFrame instance.CheckIn()
public: virtual void CheckIn() sealed
abstract CheckIn : unit -> unit override CheckIn : unit -> unit
Implements
IAFTransactableCheckInEvents
| Event Type | Reason |
|---|---|
| IAFChangedEventChanged | This event will be raised for each object updated by this method call. |
Remarks
Before an object's configuration can be modified, it must be locked by checking it out for modifications by calling the CheckOut method. After making changes, the modifications are saved by calling the ApplyChanges method or this method. All changes to the object are saved to persistent storage by calling this method. Since changes are not automatically saved, any changes since checking out this object are lost if the AFDatabase object is deleted. Changes can also be undone by calling the UndoCheckOut(Boolean) method.
Examples
For an example of various methods of using ApplyChanges and CheckIn, see the
CheckIn Example.