AFCollective.GetStatusDetails Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Gets the detailed collective status information for the collective members from the server.
Namespace: OSIsoft.AF.Collective
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFCollectiveStatus GetStatusDetails( bool errorsOnly, int maxSecondaryEntries )
Public Function GetStatusDetails ( errorsOnly As Boolean, maxSecondaryEntries As Integer ) As AFCollectiveStatus Dim instance As AFCollective Dim errorsOnly As Boolean Dim maxSecondaryEntries As Integer Dim returnValue As AFCollectiveStatus returnValue = instance.GetStatusDetails(errorsOnly, maxSecondaryEntries)
public: AFCollectiveStatus^ GetStatusDetails( bool errorsOnly, int maxSecondaryEntries )
member GetStatusDetails : errorsOnly : bool * maxSecondaryEntries : int -> AFCollectiveStatus
Parameters
- errorsOnly
- Type: SystemBoolean
If , then only errors will be returned for the Secondary collective members. Otherwise, all status entries will be returned. - maxSecondaryEntries
- Type: SystemInt32
The maximum number of Secondary collective member entries that will be returned as part of the detailed status information. If -1 is specified (the recommended default), then one row will be returned for each secondary collective member.
Return Value
Type: AFCollectiveStatusReturns the detailed status information for the collective members.
Remarks
This method can be called to obtain more detailed information about the status
of the collective and its members.
| Calling this method will cause your connection to switch to the primary collective member. |