PICollective.SwitchMember Method (Boolean, IWin32Window, AFConnectionPreference)

public void SwitchMember(
	bool autoPrompt,
	IWin32Window owner,
	AFConnectionPreference preference = AFConnectionPreference.Any
)

Public Sub SwitchMember ( 
	autoPrompt As Boolean,
	owner As IWin32Window,
	Optional preference As AFConnectionPreference = AFConnectionPreference.Any
)

Dim instance As PICollective
Dim autoPrompt As Boolean
Dim owner As IWin32Window
Dim preference As AFConnectionPreference

instance.SwitchMember(autoPrompt, owner, 
	preference)

public:
void SwitchMember(
	bool autoPrompt, 
	IWin32Window^ owner, 
	AFConnectionPreference preference = AFConnectionPreference::Any
)

member SwitchMember : 
        autoPrompt : bool * 
        owner : IWin32Window * 
        ?preference : AFConnectionPreference 
(* Defaults:
        let _preference = defaultArg preference AFConnectionPreference.Any
*)
-> unit 

Parameters

autoPrompt

Type: SystemBoolean
If , then a dialog will be displayed to prompt for user credentials if the connection to the server fails. The choice of PIAuthenticationMode in the prompt dialog is only displayed if the AllowExplicit option is set in the AuthenticationOptions setting. When this option is not set, then only WindowsAuthentication is allowed.

owner

Type: System.Windows.FormsIWin32Window
The handle to the window that owns the credential prompt dialog. If , then the owner will be the desktop. This parameter is only used if autoPrompt is and there is a security error when attempting to connect to the PI AF 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.

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.

AFSDK

Reference