Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PISystem.CheckIn Method (IList(IAFTransactable))

  • Last UpdatedNov 18, 2025
  • 3 minute read
PISystem.CheckIn Method (IList(IAFTransactable))
This method checks in (commits) the changes to the specified modified objects by saving the object's information to persistent storage.

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public void CheckIn(
	IList<IAFTransactable> objList
)
Public Sub CheckIn ( 
	objList As IList(Of IAFTransactable)
)

Dim instance As PISystem
Dim objList As IList(Of IAFTransactable)

instance.CheckIn(objList)
public:
void CheckIn(
	IList<IAFTransactable^>^ objList
)
member CheckIn : 
        objList : IList<IAFTransactable> -> unit 

Parameters

objList
Type: System.Collections.GenericIListIAFTransactable
The list of IAFTransactable objects to be checked in (committed) to persistent storage.

Events

Event TypeReason
PISystemChanged This event will be raised for each object updated by this method call.

Remarks

This method checks in (commits) the changes to the specified modified objects by saving the object's information to persistent storage. The specified objects can be system and/or database objects. If this PISystem is an AFCollective, then any changes to the Collective will also be saved to the server.

Before an object's configuration can be modified, it must be locked by checking it out for modifications by calling the CheckOut method of the object. After making changes, the modifications are saved by calling this method or the CheckIn method of the object.

Care should be taken to limit the amount of changes checked in at one time to reasonable amounts. While it is possible to make a significant number of changes at one time, these changes are transferred to the PI AF Server at one time and can thus require significant amounts of memory to complete the operation.

When checking in a large number of items and an error occurs during the check in, some objects may have been successfully checked in without the SDK knowing. When this occurs you will get an error that the object is not checked out on the next check in attempt. If this occurs, you can call PISystem.Refresh and/or AFDatabase.Refresh to update the SDK's list of successfully checked in objects.

Examples

For an example of various methods of using ApplyChanges and CheckIn, see the CheckIn Example.

Version Information

AFSDK


See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in