AFElement.CheckOut Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public bool CheckOut()
Public Function CheckOut As Boolean Dim instance As AFElement Dim returnValue As Boolean returnValue = instance.CheckOut()
public: virtual bool CheckOut() sealed
abstract CheckOut : unit -> bool override CheckOut : unit -> bool
Return Value
Type: BooleanReturns if the current information for the object (i.e. its property values) was updated with new values from the server as a result of checking it out. This could occur when another application makes a change to the object after it was loaded by the current application. Returns if the only update loaded from the server was the CheckOutInfo for the object.
Implements
IAFTransactableCheckOutEvents
| 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. After making changes, the modifications are saved by calling the ApplyChanges method or the CheckIn method. The UndoCheckOut(Boolean) method can be called to discard any changes.
Most of the properties and methods of an object which modify its configuration attempt to perform an automatic check out. This makes it easier for the user of the SDK because an explicit CheckOut method call does not have to be made before making any changes. But if changes are to be made to many objects, it better to check them out in bulk by using the bulk check out method for this object type using a list of object unique identifiers.