AF SDK Reference

PICollectiveMember.Priority Property

Save PDF

TABLE OF CONTENTS

PICollectiveMember.Priority Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Indicates the priority order in which to select a collective member.

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

Syntax

public int Priority { get; set; }

Public Property Priority As Integer
	Get
	Set

Dim instance As PICollectiveMember
Dim value As Integer

value = instance.Priority

instance.Priority = value

public:
property int Priority {
	int get ();
	void set (int value);
}

member Priority : int with get, set

Property Value

Type: Int32

Indicates the priority order in which to select a collective member when connection preferences and availability of members don't override the choice.

The highest priority member is given a priority of 1. Users can modify these values to any positive integer on their workstation to establish their preferred connection order. A negative priority indicates connections to that member are not allowed.

Remarks

When connecting to a collective, you can specify the AFConnectionPreference as a parameter to the PIServer.Connect() method. If not specified as a parameter, then the AFConnectionInfo.Preference is used. When the preference is set to Any or PreferPrimary and the primary server is unavailable, then this property determines the choice of the collective member for a connection attempt. By setting priorities appropriately on user workstations and running HA aware applications that use Any as a connection preference, the load on a collective can be distributed among its members.

AF SDK Reference