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

AF SDK Reference

OSIsoft.AF.PI Namespace

  • Last UpdatedNov 18, 2025
  • 7 minute read
OSIsoft.AF.PI Namespace
The OSIsoft.AF.PI namespace provides a set of classes that can be used to manage connections and access information about a PI Data Archive.

Classes

  ClassDescription
Public class
PIAuthenticationException
Represents an authentication error returned from the PIServer.
Public class
PIBufferException
Represents an error related to buffering PI data writes.
Public class
PICollective
The PICollective object is used to provide the information and status about the PIServer collective.
Public class
PICollectiveMember
The PICollectiveMember object is used to provide the information about the member server defined within the PICollective.
Public class
PICollectiveMembers
A collection of PICollectiveMember objects maintained by the PICollective.
Public class
PICommonPointAttributes
This class contains information about common PIPoint attributes.
Public class
PIConfigurationException
Represents a configuration error reading the list of configured PIServers.
Public class
PIConnectFailedEventArgs
Provides data for the ConnectFailed event.
Public class
PIConnectionException
Represents a connection error attempting to communicate with the specified PIServer.
Public class
PIConnectionInfo
The PIConnectionInfo object is used to provide the connection configuration information and status to the PIServer.
Public class
PIDatabaseSecurities
The PIDatabaseSecurities collection represents the available PIDatabaseSecurity objects on a particular PIServer.
Public classCode example
PIDatabaseSecurity
The PIDatabaseSecurity object represents an access control to a PIServer table resource.
Public classCode example
PIDataPipe
The PIDataPipe is used to subscribe for data change events on a list of PIPoint instances. The PIPoint instances do not have to be associated with the same PIServer. PIDataPipe instances can sign up for archive, snapshot or timeseries events. The pipe type is specified when the data pipe object is constructed.
Public class
PIException
Represents an error returned from the PIServer.
Public classCode example
PIIdentities
The PIIdentities collection represents the available PIIdentity objects on a particular PIServer.
Public classCode example
PIIdentity
The PIIdentity object represents an identity on a PIServer.
Public classCode example
PIIdentityMapping
The PIIdentityMapping object represents a mapping between Windows identity and PIIdentity on a PIServer.
Public classCode example
PIIdentityMappings
The PIIdentityMappings collection represents the available PIIdentityMapping objects on a particular PIServer.
Public class
PIPagingConfiguration
The PIPagingConfiguration is used to describe how PIPointList and AFListData data access calls should page results for better performance.
Public classCode example
PIPoint
The PIPoint object represents a point on a PIServer.
Public class
PIPointChangesCookie
The PIPointChangesCookie is used in subsequent calls to FindChangedPIPoints(Int32, Object, PIPointChangesCookie, IEnumerablePIPoint) to retrieve changes that have occurred, since the last call was made. This object is serializable, so that consumers can serialize the object before shutdown and reconstitute it on startup.
Public classCode example
PIPointClass
The PIPointClass object represents a point class on a PIServer.
Public classCode example
PIPointClasses
The PIPointClasses collection represents the available PIPointClass objects on a particular PIServer.
Public class
PIPointInvalidException
The PIPoint is no longer valid on the PIServer. Most likely, the point is deleted on the server.
Public classCode example
PIPointList
The PIPointList object represents a list of PIPoint objects. The PIPoints can be on different PIServer. PIPointList supports duplicate PIPoint in the list.
Public classCode example
PIPointSource
The PIPointSource object represents a point source on a PIServer.
Public class
PIPointSources
The PIPointSources collection represents the point sources that have been created on a particular PIServer.
Public class
PISerializationException Obsolete.
Represents a serialization error in data returned from the PIServer.
Public classCode example
PIServer
The PIServer object represents a single PI Data Archive.
Public classCode example
PIServers
The global collection of PIServer objects that represents the known PI Data Archive servers available from a workstation for client applications.
Public classCode example
PIStateSets
The PIStateSets collection represents the available State Sets on a particular PIServer. The State Sets are represented as a collection of AFEnumerationSet objects.
Public class
PITimeoutException
Represents a timeout error returned from the PIServer.
Public class
PIVersionNotSupportedException
Represents an error when the version of the PIServer is not supported.

Structures

  StructureDescription
Public structure
PIBufferStatus
The BufferStatus contains buffering-related information of the PI Buffer Subsystem or a PIServer.
Public structure
PIPointChangeInfo
The PIPointChangeInfo structure is used when returning information about PI Points that have changed in the PIServer.
Public structure
PIPointQuery
PIPoint attribute value search query structure.

Enumerations

  EnumerationDescription
Public enumeration
PIAuthenticationMode
The authentication mode to use when making an explicit connection to a PIServer.
Public enumeration
PIAuthenticationOption
Defines the authentication options used when making a connection to a PIServer.
Public enumeration
PIBufferHealthStatus
This enumeration defines the possible values for the Health.
Public enumeration
PIConnectionResult
Defines the results of a connection attempt to a PIServer.
Public enumeration
PIIdentityMappingType
This enumeration defines the types of PIIdentityMapping.
Public enumeration
PIIdentityType
This enumeration defines the types of PIIdentity.
Public enumeration
PIPageType
The PIPageType is used to determine how partial results from list data access calls should be grouped while being returned to the client. Choosing the appropriate partition type will improve performance.
Public enumeration
PIPointType
This enumeration defines the values for the PIPoint.PointType property.
Public enumeration
PIServerFeature
This enumeration represents the features that are supported for the PIServer.
TitleResults for “How to create a CRG?”Also Available in