AFDatabase.FindCheckedOutItems Method (AFCheckedOutMode)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
This method finds the items that are currently checked out in the
AFDatabase according to the specified AFCheckedOutMode.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public IList<IAFTransactable> FindCheckedOutItems( AFCheckedOutMode mode )
Public Function FindCheckedOutItems ( mode As AFCheckedOutMode ) As IList(Of IAFTransactable) Dim instance As AFDatabase Dim mode As AFCheckedOutMode Dim returnValue As IList(Of IAFTransactable) returnValue = instance.FindCheckedOutItems(mode)
public: IList<IAFTransactable^>^ FindCheckedOutItems( AFCheckedOutMode mode )
member FindCheckedOutItems : mode : AFCheckedOutMode -> IList<IAFTransactable>
Parameters
- mode
- Type: OSIsoft.AFAFCheckedOutMode
The mode is used to restrict the objects that are returned based upon how they were checked out.
Return Value
Type: IListIAFTransactableReturns a list of IAFTransactable objects that are currently checked out in the AFDatabase.
Remarks
This method is used to find the items that are currently checked out in the AFDatabase. The mode parameter can be used to filter the list of returned objects based upon how they were checked out.
Since the SDK does maintain a list of currently checked out items at the database level, this method will not make a call to the server to obtain the list of checked out items. Call one of the AFDatabaseRefresh methods to update the list with items that may have been checked in or out by another client. The returned list will also include any new objects that have not been saved to the server.