Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PICollective.SwitchMember Method (PICollectiveMember)

PICollective.SwitchMember Method (PICollectiveMember)

  • Last UpdatedNov 18, 2025
  • 2 minute read
PICollective.SwitchMember Method (PICollectiveMember)
The SwitchMember method is used to change to the specified member of the collective using default credentials.

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public void SwitchMember(
	PICollectiveMember member
)
Public Sub SwitchMember ( 
	member As PICollectiveMember
)

Dim instance As PICollective
Dim member As PICollectiveMember

instance.SwitchMember(member)
public:
void SwitchMember(
	PICollectiveMember^ member
)
member SwitchMember : 
        member : PICollectiveMember -> unit 

Parameters

member
Type: OSIsoft.AF.PIPICollectiveMember
The preferred member of the PICollective selected for the connection. If the member is not available, then the connection will failover to another member.

Remarks

This method will change the currently connected member of the collective to the specified member if the current Priority settings allow a connection to this member. 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.

Version Information

AFSDK


See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in