OSIsoft.AF.PI Namespace
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
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
| Class | Description | |
|---|---|---|
| PIAuthenticationException |
Represents an authentication error returned from the PIServer.
| |
| PIBufferException |
Represents an error related to buffering PI data writes.
| |
| PICollective |
The PICollective object is used to provide the
information and status about the PIServer collective.
| |
| PICollectiveMember |
The PICollectiveMember object is used to provide the
information about the member server defined within the
PICollective.
| |
| PICollectiveMembers |
A collection of PICollectiveMember objects maintained by the
PICollective.
| |
| PICommonPointAttributes |
This class contains information about common PIPoint attributes.
| |
| PIConfigurationException |
Represents a configuration error reading the list of configured PIServers.
| |
| PIConnectFailedEventArgs |
Provides data for the ConnectFailed event.
| |
| PIConnectionException |
Represents a connection error attempting to communicate with the specified PIServer.
| |
| PIConnectionInfo |
The PIConnectionInfo object is used to provide the
connection configuration information and status to the PIServer.
| |
| PIDatabaseSecurities |
The PIDatabaseSecurities collection represents the available
PIDatabaseSecurity objects on a particular PIServer.
| |
| PIDatabaseSecurity |
The PIDatabaseSecurity object represents an access control to a PIServer table resource.
| |
| 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.
| |
| PIException |
Represents an error returned from the PIServer.
| |
| PIIdentities | ||
| PIIdentity |
The PIIdentity object represents an identity on a PIServer.
| |
| PIIdentityMapping |
The PIIdentityMapping object represents a mapping between Windows identity and PIIdentity on a PIServer.
| |
| PIIdentityMappings |
The PIIdentityMappings collection represents the available
PIIdentityMapping objects on a particular PIServer.
| |
| PIPagingConfiguration |
The PIPagingConfiguration is used to describe how PIPointList and AFListData data access calls
should page results for better performance.
| |
| PIPoint |
The PIPoint object represents a point on a PIServer.
| |
| 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.
| |
| PIPointClass |
The PIPointClass object represents a point class on a PIServer.
| |
| PIPointClasses |
The PIPointClasses collection represents the available
PIPointClass objects on a particular PIServer.
| |
| PIPointInvalidException |
The PIPoint is no longer valid on the PIServer. Most likely, the point is deleted on the server.
| |
| PIPointList | ||
| PIPointSource |
The PIPointSource object represents a point source on a PIServer.
| |
| PIPointSources |
The PIPointSources collection represents the point sources that have been
created on a particular PIServer.
| |
| PISerializationException | Obsolete.
Represents a serialization error in data returned from the PIServer.
| |
| PIServer |
The PIServer object represents a single PI Data Archive.
| |
| PIServers |
The global collection of PIServer objects
that represents the known PI Data Archive servers available from
a workstation for client applications.
| |
| PIStateSets |
The PIStateSets collection represents the available State Sets
on a particular PIServer. The State Sets are represented
as a collection of AFEnumerationSet objects.
| |
| PITimeoutException |
Represents a timeout error returned from the PIServer.
| |
| PIVersionNotSupportedException |
Represents an error when the version of the PIServer is not supported.
|
Structures
| Structure | Description | |
|---|---|---|
| PIBufferStatus |
The BufferStatus contains buffering-related information of the PI Buffer Subsystem or a PIServer.
| |
| PIPointChangeInfo |
The PIPointChangeInfo structure is used when returning information about PI Points that have changed in the PIServer.
| |
| PIPointQuery | PIPoint attribute value search query structure.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
| PIAuthenticationMode |
The authentication mode to use when making an explicit connection
to a PIServer.
| |
| PIAuthenticationOption |
Defines the authentication options used when making a connection to a PIServer.
| |
| PIBufferHealthStatus |
This enumeration defines the possible values for the Health.
| |
| PIConnectionResult |
Defines the results of a connection attempt to a PIServer.
| |
| PIIdentityMappingType |
This enumeration defines the types of PIIdentityMapping.
| |
| PIIdentityType |
This enumeration defines the types of PIIdentity.
| |
| 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.
| |
| PIPointType |
This enumeration defines the values for the
PIPoint.PointType property.
| |
| PIServerFeature |
This enumeration represents the features that are supported for
the PIServer.
|
In This Topic
Related Links
- PIAuthenticationException Class
- PIAuthenticationMode Enumeration
- PIAuthenticationOption Enumeration
- PIBufferException Class
- PIBufferHealthStatus Enumeration
- PIBufferStatus Structure
- PICollective Class
- PICollectiveMember Class
- PICollectiveMembers Class
- PICommonPointAttributes Class
- PIConfigurationException Class
- PIConnectFailedEventArgs Class
- PIConnectionException Class
- PIConnectionInfo Class
- PIConnectionResult Enumeration
- PIDatabaseSecurities Class
- PIDatabaseSecurity Class
- PIDataPipe Class
- PIException Class
- PIIdentities Class
- PIIdentity Class
- PIIdentityMapping Class
- PIIdentityMappings Class
- PIIdentityMappingType Enumeration
- PIIdentityType Enumeration
- PIPageType Enumeration
- PIPagingConfiguration Class
- PIPoint Class
- PIPointChangeInfo Structure
- PIPointChangesCookie Class
- PIPointClass Class
- PIPointClasses Class
- PIPointInvalidException Class
- PIPointList Class
- PIPointQuery Structure
- PIPointSource Class
- PIPointSources Class
- PIPointType Enumeration
- PISerializationException Class
- PIServer Class
- PIServerFeature Enumeration
- PIServers Class
- PIStateSets Class
- PITimeoutException Class
- PIVersionNotSupportedException Class