Click or drag to resize
OSIsoft, LLC

PIConnectionInfo Class

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: 2.10.6.195
Syntax
public sealed class PIConnectionInfo

The PIConnectionInfo type exposes the following members.

Properties
  NameDescription
Public propertyConnectionTimeOut
Read/write property that is the timeout used to connect to the PIServer on the remote host.
Public propertyStatic memberDefaultPreference
The default connection preference to be used when attempting to connect to a member in a PICollective.
Public propertyHost
This property is the name of the host machine where the PIServer is executing.
Public propertyIsConnected
Indicates the connection status to the PIServer.
Public propertyOperationTimeOut
Read/write property that is the timeout used to perform operations on the PIServer.
Public propertyPIServer
This read-only property allows access to the PIServer associated with this object.
Public propertyPort
Read/write property that is the port number used to connect to the PIServer on the remote host.
Public propertyPreference
The default connection preference override to be used when attempting to connect to a member in a PICollective for this PIServer instance.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current object.
(Overrides ObjectToString.)
Top
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.

Note Notes to Callers
This method, property, or class is only available in the .NET 4 version of the SDK.

Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also
Enabling Operational Intelligence