AFCheckedOutMode Enumeration
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines the different modes that can be specified when checking in or finding modified objects.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public enum AFCheckedOutMode
Public Enumeration AFCheckedOutMode Dim instance As AFCheckedOutMode
public enum class AFCheckedOutMode
type AFCheckedOutMode
Members
| Member name | Value | Description | |
|---|---|---|---|
| AllObjects | 0 | Used in the FindCheckedOutItems(AFCheckedOutMode) method to find all checked out items, regardless of the user who has them checked out. This mode is not valid for the CheckIn(AFCheckedOutMode) or ApplyChanges(AFCheckedOutMode) methods. | |
| ObjectsCheckedOutToMe | 1 | When used with CheckIn(AFCheckedOutMode), all objects checked out to the current user are checked in. When used with ApplyChanges(AFCheckedOutMode), all objects modified by the current user are applied. This is the default when a mode is not specified for either of these methods. When used with FindCheckedOutItems(AFCheckedOutMode), the list of all objects checked out to the current user are returned. | |
| ObjectsCheckedOutThisSession | 2 | When used with CheckIn(AFCheckedOutMode), all objects which have been checked out or modified in the current executable session are checked in. When used with ApplyChanges(AFCheckedOutMode), all objects which have been modified in the current executable session are applied. When used with FindCheckedOutItems(AFCheckedOutMode), the list of all objects checked out or modified in the current executable session are returned. | |
| ObjectsCheckedOutThisThread | 3 | When used with CheckIn(AFCheckedOutMode), all objects which have been checked out or modified by the current thread are checked in. When used with ApplyChanges(AFCheckedOutMode), all objects which have been modified by the current thread are applied. When used with FindCheckedOutItems(AFCheckedOutMode), the list of all objects checked out or modified by the current thread are returned. Only the first thread to check out or modify an object is tracked. Subsequent changes by other threads are not tracked. |
Remarks
The checkout mode defines which objects are checked in when doing a database
CheckIn(AFCheckedOutMode).
The checkout mode also determines what is returned by the
FindCheckedOutItems(AFCheckedOutMode) method.