PISystem.CanCreateCollective Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Check if a collective can be created for this PISystem.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFErrorStatus CanCreateCollective( out string message )
Public Function CanCreateCollective ( <OutAttribute> ByRef message As String ) As AFErrorStatus Dim instance As PISystem Dim message As String Dim returnValue As AFErrorStatus returnValue = instance.CanCreateCollective(message)
public: AFErrorStatus CanCreateCollective( [OutAttribute] String^% message )
member CanCreateCollective : message : string byref -> AFErrorStatus
Parameters
- message
- Type: SystemString
If the return is Warning or Error, then this parameter will contain the warning or error message.
Return Value
Type: AFErrorStatusReturns None if no problems were detected with creating an AFCollective from the PISystem. Returns Warning when a check could not be performed on the server, usually because of a security restriction. Returns Error when an error condition was detected that would prevent the creation of an AFCollective from the PISystem.
Remarks
This method should be called before calling the CreateCollective method
to check if the PISystem can be converted to an AFCollective.
The SQL Server cannot be an Express version and the SQL Server Agent must be running in
order to allow a PISystem to be converted to an AFCollective.