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

AF SDK Reference

AFCollective.SwitchMember Method (NetworkCredential, AFConnectionPreference)

AFCollective.SwitchMember Method (NetworkCredential, AFConnectionPreference)

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFCollective.SwitchMember Method (NetworkCredential, AFConnectionPreference)
The SwitchMember method is used to change the currently connected member of the collective using the specified credentials.

Namespace:  OSIsoft.AF.Collective
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 AFCollective
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 to use when connecting to the server.
preference (Optional)
Type: OSIsoft.AFAFConnectionPreference
The connection preference to use when determining which member of the AFCollective 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 AFConnectionInfo.Preference and AFCollectiveMember.Priority settings.

Version Information

AFSDK


See Also

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