PISystem.CreateCollective Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Convert the PISystem into a member of a new AFCollective.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFCollective CreateCollective()
Public Function CreateCollective As AFCollective Dim instance As PISystem Dim returnValue As AFCollective returnValue = instance.CreateCollective()
public: AFCollective^ CreateCollective()
member CreateCollective : unit -> AFCollective
Return Value
Type: AFCollectiveReturns the new AFCollective associated with the PISystem.
Remarks
This method is used to convert the current PISystem into a member of a new AFCollective. A new AFCollective will be created and the current PISystem will be initialized as the Primary member of the collective. The Collective property of the current PISystem will be set to the new AFCollective object.
After finished configuring the AFCollective, use one of the AFCollective.ApplyChanges Overload methods to save the changes to the server.
| The CanCreateCollective(String) method should be called before calling this method to check for potential problems with creating an AFCollective from the PISystem. |