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

AF SDK Reference

TABLE OF CONTENTS

PIServer Methods

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 11 minute read
PIServer Methods

The PIServer type exposes the following members.

Methods

  NameDescription
Public method
CompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFObject.)
Public method
CompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public methodCode example
Connect(Boolean)
Open a connection to the PI Data Archive using default credentials to allow sending and retrieving data.
Public methodCode example
Connect(NetworkCredential)
Open a connection to the PI Data Archive using the specified PI User credentials to allow sending and retrieving data.
Public method
Connect(String)
Connects to the server using the specified Access Token to allow sending and retrieving data.
Public methodCode example
Connect(AFConnectionPreference)
Open a connection to the PI Data Archive using the specified connection preference to allow sending and retrieving data.
Public methodCode example
Connect(Boolean, IWin32Window)
Open a connection to the PI Data Archive with a credential prompt if necessary to allow sending and retrieving data.
Public methodCode example
Connect(NetworkCredential, AFConnectionPreference)
Open a connection to the PI Data Archive using the specified PI User credentials and connection preference to allow sending and retrieving data.
Public methodCode example
Connect(NetworkCredential, PIAuthenticationMode)
Open a connection to the PI Data Archive using the specified credentials to allow sending and retrieving data.
Public method
Connect(String, AFConnectionPreference)
Connects to the server using the specified Access Token to allow sending and retrieving data.
Public method
Connect(String, String)
Connects to the server using the specified credentials to allow sending and retrieving data.
Public methodCode example
Connect(Boolean, IWin32Window, AFConnectionPreference)
Open a connection to the PI Data Archive using the specified connection preference with a credential prompt if necessary to allow sending and retrieving data.
Public methodCode example
Connect(NetworkCredential, AFConnectionPreference, PIAuthenticationMode)
Open a connection to the PI Data Archive using the specified credentials and connection preference to allow sending and retrieving data.
Public method
Connect(String, String, AFConnectionPreference)
Connects to the server using the specified credentials to allow sending and retrieving data.
Public methodCode example
Connect(Boolean, IWin32Window, AFConnectionPreference, Boolean)
Open a connection to the PI Data Archive using the specified connection preference with a credential prompt if necessary to allow sending and retrieving data and return an indication that dialog was canceled.
Public method
ConnectWithPrompt
Connects to the server prompting for credentials.
Public methodCode example
ConnectWithPrompt(IWin32Window)
Open a connection to the PI Data Archive prompting for credentials to allow sending and retrieving data.
Public methodCode example
ConnectWithPrompt(AFConnectionPreference)
Open a connection to the PI Data Archive prompting for credentials to allow sending and retrieving data.
Public methodCode example
ConnectWithPrompt(IWin32Window, PIAuthenticationMode, NullableAFConnectionPreference)
Open a connection to the PI Data Archive prompting for credentials to allow sending and retrieving data.
Public method
CreatePIPoint
Create a new PIPoint on the current PIServer.
Public method
CreatePIPoints(IDictionaryString, IDictionaryString, Object)
Create a list of new PIPoint objects on the current PIServer with each point having a different set of attribute values.
Public method
CreatePIPoints(IEnumerableString, IDictionaryString, Object)
Create a list of new PIPoint objects on the current PIServer with all points having the same attribute values.
Public method
DeletePIPoint
Delete a PIPoint from the PIServer.
Public method
DeletePIPoints
Delete a list of PIPoint objects from the PIServer.
Public method
Disconnect
Close a connection to the PI Data Archive.
Public method
Equals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides AFObjectEquals(Object).)
Public method
Equals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public method
Equals(PIServer)
Indicates whether the current object is equal to another object of the same type.
Public method
ExportCsv(Object, IListObject, IListString, CultureInfo)
Exports the CSV representation of requested object(s) and returns it as a string. The supported objects include PI Points, PI DigitalStateSets, PI Identities, or PI IdentityMappings.
Public method
ExportCsv(Object, IListObject, IListString, PIExportMode, CultureInfo)
Exports the CSV representation of requested object(s) and returns it as a string. The supported objects include PI Points, PI DigitalStateSets, PI Identities, or PI IdentityMappings.
Public method
ExportCsv(Object, IListObject, IListString, CultureInfo, String, EventHandlerAFProgressEventArgs)
Exports the representation of requested object(s) in comma-separated (CSV) format to a file. The supported objects include PI Points, PI DigitalStateSets, PI Identities, or PI IdentityMappings.
Public method
ExportCsv(Object, IListObject, IListString, PIExportMode, CultureInfo, String, EventHandlerAFProgressEventArgs)
Exports the representation of requested object(s) in comma-separated (CSV) format to a file. The supported objects include PI Points, PI DigitalStateSets, PI Identities, or PI IdentityMappings.
Public methodCode example
FindChangedPIPoints
Find all the PI Points that have changed in the PIServer.
Public methodStatic member
FindPIServer(Guid)
Find the PIServer from the specified unique identifier.
Public methodStatic member
FindPIServer(String)
Find the PIServer from the specified name.
Public methodStatic member
FindPIServer(PISystem, Guid)
Find the PIServer from the specified unique identifier using the credentials of the current user associated with the specified PISystem.
Public methodStatic member
FindPIServer(PISystem, String)
Find the PIServer from the specified name using the credentials of the current user associated with the specified PISystem.
Public method
GetAnnotations
Gets the annotations associated with list of historical events.
Public method
GetBufferStatus
This method gets the PIBufferStatus for the corresponding PIServer.
Public method
GetClientRpcMetrics
Get the remote procedure call metrics to the server for this PIServer.
Public method
GetCsvColumns(Type, Boolean)
Retrieve a collection containing the required and optional CSV columns for the specified object type and its children. The supported objects include PI Points, PI DigitalStateSets, PI Identities, or PI IdentityMappings.
Public method
GetCsvColumns(Type, IListObject, Boolean)
Retrieve a collection containing the required and optional CSV columns for the specified object type and its children. The supported objects include PI Points, PI DigitalStateSets, PI Identities, or PI IdentityMappings.
Public method
GetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides AFObjectGetHashCode.)
Public method
GetIdentityServerBestRsso
Method to retrieve the Best Redundant Single Sign-On Server Endpoint for the Identity Server for the .
Public method
GetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public method
GetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public method
GetPath(AFEncodeType, AFObject)
Returns the path to the object relative from another object, using the name and/or id as specified by encodeType.
(Inherited from AFObject.)
Public method
GetPointAttributeNames
Get the list of PIPoint attributes names for the PIServer.
Public method
GetPointCount
This method gets the total point count for the corresponding PIServer.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
ImportCsv(PIImportMode, CultureInfo, Stream, EventHandlerAFProgressEventArgs)
Imports the comma-separated value (CSV) representation of PI Points, PI DigitalStateSets, PI Identities, or PI IdentityMappings from a stream.
Public method
ImportCsv(PIImportMode, CultureInfo, String, EventHandlerAFProgressEventArgs)
Imports the comma-separated value (CSV) representation of PI Points, PI DigitalStateSets, PI Identities, or PI IdentityMappings from a file.
Public method
LogOut
Logs out the current OIDC user and closes all associated connections to the PI Data Archive.
Public method
Persist
This method returns the persistence string for the object.
(Overrides AFObjectPersist.)
Public method
Refresh
Refresh the cached information for the PIServer.
Public method
RefreshOIDCToken
Refreshes OIDC token on the PI Data Archive. New access token to refresh the connection; if null, will try refresh token if available. This exception will be generated if newAccessToken and refresh token are both unavailable.
Public method
ReplaceValues(AFTimeRange, IListAFValues)
This method removes existing data within the specified AFTimeRange and inserts the specified values.
Public method
ReplaceValues(AFTimeRange, IListAFValues, AFBufferOption)
This method removes existing data within the specified AFTimeRange and inserts the specified values.
Public method
Supports
Checks if the specified PIServerFeature feature is supported by the PIServer.
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFObject.)
Public methodStatic member
TryConvertToServerID
Convert a string key to a PIServer ID.
Public method
UpdateValues(IListAFValue, AFUpdateOption)
Update, write or delete the PIPoint value for each AFValue in the specified list.
Public methodCode example
UpdateValues(IListAFValue, AFUpdateOption, AFBufferOption)
Update the PIPoint value for each AFValue in the specified list.
Public method
UpdateValuesAsync(IListAFValue, AFUpdateOption, CancellationToken)
Update the PIPoint value for each AFValue in the specified list.
Public method
UpdateValuesAsync(IListAFValue, AFUpdateOption, AFBufferOption, CancellationToken)
Update the PIPoint value for each AFValue in the specified list.

See Also

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