AFConnectionInfo Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFConnectionInfo object is used to provide the
connection configuration information and status to the PI AF Server.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFConnectionInfo
OSIsoft.AFAFConnectionInfo
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFConnectionInfo
Public NotInheritable Class AFConnectionInfo Dim instance As AFConnectionInfo
public ref class AFConnectionInfo sealed
[<SealedAttribute>] type AFConnectionInfo = class end
The AFConnectionInfo type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AccountName |
This property is the account name that the PI AF Server
for this PISystem is executing under.
|
| AuthenticationType |
Read-only property that returns the Authentication Type used by the server.
On older servers this will return string.empty .
|
 | DefaultPreference |
The default connection preference to be used when attempting to connect to
a member in an AFCollective.
|
| Expiration |
Read-only property that returns the Token Expiration used by OpenID connections
to the AF 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 PI AF Server
for this PISystem is executing.
|
| IdleTimeout |
Read-only property that is the connection idle timeout used to reset the connection
to the PI AF Server for this PISystem.
|
| IsConnected |
Indicates the connection status to the PI AF Server.
|
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
|
| Port |
Read/write property that is the port number used to connect to the PI AF Server
for this PISystem on the remote host.
|
| Preference |
The default connection preference override to be used when attempting to connect to
a member in an AFCollective for this PISystem instance.
|
| Protocol |
Read/write property that is the protocol used to connect to the PI AF Server for
this PISystem on the remote host.
|
| StreamedPort |
Read-only property that is the port number used to connect to the streamed interface of
the PI AF Server for this PISystem on the remote host.
|
| TimeOut |
Read/write property that is the connection timeout used to connect to the PI AF Server
for this PISystem on the remote host.
|
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 PI AF Server. The Host,
Protocol, and Port properties provide
configuration information about the connection to the PI AF Server.