AF SDK Reference

PIConnectionInfo Class

Save PDF

TABLE OF CONTENTS

PIConnectionInfo Class

Save PDF

Last UpdatedNov 18, 2025
4 minute read

The PIConnectionInfo object is used to provide the connection configuration information and status to the PIServer.

Inheritance Hierarchy

SystemObject
OSIsoft.AF.PIPIConnectionInfo

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

Syntax

public sealed class PIConnectionInfo

Public NotInheritable Class PIConnectionInfo

Dim instance As PIConnectionInfo

public ref class PIConnectionInfo sealed

[<SealedAttribute>]
type PIConnectionInfo =  class end

The PIConnectionInfo type exposes the following members.

Properties

	Name	Description
	ConnectionTimeOut	Read/write property that is the timeout used to connect to the PIServer on the remote host.
	DefaultPreference	The default connection preference to be used when attempting to connect to a member in a PICollective.
	Expiration	Read-only property that returns the Token Expiration used by OpenID connections to the PI server. For windows connections, this will return DateTime.MinValue. For openId connections, this will return the access token expiration.
	Host	This property is the name of the host machine where the PIServer is executing.
	IsConnected	Indicates the connection status to the PIServer.
	OperationTimeOut	Read/write property that is the timeout used to perform operations on the PIServer.
	PIServer	This read-only property allows access to the PIServer associated with this object.
	Port	Read/write property that is the port number used to connect to the PIServer on the remote host.
	Preference	The default connection preference override to be used when attempting to connect to a member in a PICollective for this PIServer instance.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current object. (Overrides ObjectToString.)

Remarks

The IsConnected property returns the current connection status to the PIServer. The Host and Port properties provide configuration information about the connection to the PIServer.

Notes to Callers
This method, property, or class is not available in the legacy .NET 3.5 version of the SDK.

AF SDK Reference