PICollective.SwitchMember Method (NetworkCredential, AFConnectionPreference)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
The SwitchMember method is used to change the currently connected
member of the collective using the specified PI User credentials.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public void SwitchMember( NetworkCredential credential, AFConnectionPreference preference = AFConnectionPreference.Any )
Public Sub SwitchMember ( credential As NetworkCredential, Optional preference As AFConnectionPreference = AFConnectionPreference.Any ) Dim instance As PICollective Dim credential As NetworkCredential Dim preference As AFConnectionPreference instance.SwitchMember(credential, preference)
public: void SwitchMember( NetworkCredential^ credential, AFConnectionPreference preference = AFConnectionPreference::Any )
member SwitchMember : credential : NetworkCredential * ?preference : AFConnectionPreference (* Defaults: let _preference = defaultArg preference AFConnectionPreference.Any *) -> unit
Parameters
- credential
- Type: System.NetNetworkCredential
The NetworkCredential for the PI User to use when connecting to the server. - preference (Optional)
- Type: OSIsoft.AFAFConnectionPreference
The connection preference to use when determining which member of the PICollective is selected for the connection. The current connection failover behavior is not modified. Use Any to switch to the next collective member based upon the current connection's failover behavior.
Remarks
This method will change the currently connected member of the collective based upon the specified preference and the current Priority settings of the collective members for the current connection. This method will not modify the current failover behavior of the PICollective established with the initial connection to the collective.
A direct connection can be made to a collective member using one of the PICollectiveMember.Connect Overload methods. If the current connection to a collective member is a direct connection, then this method will establish a normal failover connection before switching members.