Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFSession Structure

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFSession Structure
This structure is used to represent a session on the PI AF Application Server.

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

Syntax

public struct AFSession
Public Structure AFSession

Dim instance As AFSession
public value class AFSession
[<SealedAttribute>]
type AFSession =  struct end

The AFSession type exposes the following members.

Properties

  NameDescription
Public property
AuthenticationType
The authentication type of the account which made the connection.
Public property
ClientHost
The IP address of the client host which made the connection.
Public property
ClientPort
The port number of the client host which made the connection.
Public property
EndTime
The end time of the connection.
Public property
GracefulTermination
A boolean that indicates if the end time was logged for graceful client termination.
Public property
StartTime
The start time of the connection.
Public property
UserName
The user name of the account which made the connection.

Methods

  NameDescription
Public method
Equals
Indicates whether this instance and a specified object are equal.
(Inherited from ValueType.)
Public method
GetHashCode
Returns the hash code for this instance.
(Inherited from ValueType.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
ToString
Returns a String that represents the current object.
(Overrides ValueTypeToString.)

Remarks

The structure is returned by the GetSessions Overload method.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in