AF SDK Reference

PIConnectionInfo.DefaultPreference Property

Save PDF

TABLE OF CONTENTS

PIConnectionInfo.DefaultPreference Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

The default connection preference to be used when attempting to connect to a member in a PICollective.

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

Syntax

public static AFConnectionPreference DefaultPreference { get; set; }

Public Shared Property DefaultPreference As AFConnectionPreference
	Get
	Set

Dim value As AFConnectionPreference

value = PIConnectionInfo.DefaultPreference

PIConnectionInfo.DefaultPreference = value

public:
static property AFConnectionPreference DefaultPreference {
	AFConnectionPreference get ();
	void set (AFConnectionPreference value);
}

static member DefaultPreference : AFConnectionPreference with get, set

Property Value

Type: AFConnectionPreference
Returns the default connection preference to be used when attempting to connect to a member in a PICollective. The default value for this property is PreferPrimary.

Remarks

This property is used to indicate the connection preference when attempting to connect to a member in a PICollective. This preference is used to influence the selection of a PICollectiveMember when a connection is made to the PICollective and not overridden on the PIServer instance Preference setting and not specified in the PIServer.Connect() call when attempting to connect to the server.

Important
This is a client setting and is not persisted between application instances.

AF SDK Reference