PIServers Methods
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The PIServers type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Add |
Registers a new PIServer to the list of known servers on the local machine.
|
| Clear |
Unregisters all existing PIServer entries from the list of known
PI Data Archive servers on the local machine.
|
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
|
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
|
| Contains(PIServer) |
This method determines whether the collection contains a specific item.
|
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
|
| DisconnectAll |
Disconnects all PIServers that are currently connected.
|
| Equals |
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).) |
| GetBufferStatus |
This method gets the PIBufferStatus of the PI Buffer Subsystem.
|
| GetEnumerator |
Returns an enumerator that iterates through the collection.
|
| 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 ObjectGetHashCode.) |
 | GetPIServers(PISystem) |
Get the list of known PIServers on the local machine.
|
| GetPIServers(ClaimsIdentity, Boolean) |
Get the list of known PIServers on the local machine.
|
| GetPIServers(String, String, Boolean) |
Get the list of known PIServers on the local machine.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
|
| Refresh |
Refresh the list of known PI Data Archive servers on the local machine,
where the cached collections of connected servers will be refreshed.
|
| Refresh(Boolean) |
Refresh the list of known PI Data Archive servers on the local machine
with the option to refresh cached collections for connected servers.
|
| Remove(Guid) |
Unregisters an existing PIServer with the specified unique identifier.
|
| Remove(String) |
Unregisters an existing PIServer with the specified name.
|
| Remove(PIServer) |
Unregisters the specified PIServer.
|
| RemoveAt |
Unregisters an existing PIServer by removing the entry from the list of known
PI Data Archive servers on the local machine.
|
| Sort |
Sorts the items in the entire collection using the default comparer.
|
| Sort(IComparerPIServer) |
Sorts the items in the entire collection using the specified comparer.
|
| Sort(Int32, Int32, IComparerPIServer) |
Sorts the items in a range of items in the collection using the specified comparer.
|
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
Extension Methods
| Name | Description | |
|---|---|---|
 | AggregatePIServer |
Performs all requested aggregates on the specified items.
(Defined by AFAggregate.) |
| AggregateAsyncPIServer |
Performs all requested aggregates on the specified items asynchronously.
(Defined by AFAggregate.) |
| BinnedSummaryPIServer, TBin |
Generates a summary broken down by the specified bins for items matching the search criteria.
(Defined by AFAggregate.) |
| BinnedSummaryAsyncPIServer, TBin |
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Defined by AFAggregate.) |
 | ChunkedByPIServer |
This extension method breaks up search results into chunks to make it easier to
page through and process IEnumerableT collections in chunks.
(Defined by AFSDKExtension.) |
| FrequencyDistributionPIServer |
Generates a frequency distribution for the specified items.
(Defined by AFAggregate.) |
| FrequencyDistributionAsyncPIServer |
Generates a frequency distribution for the specified items asynchronously.
(Defined by AFAggregate.) |
| GroupedSummaryPIServer |
Generates a summary broken down by group for the specified items.
(Defined by AFAggregate.) |
| GroupedSummaryAsyncPIServer |
Generates a histogram for the specified items asynchronously.
(Defined by AFAggregate.) |
| HistogramPIServer, TBin |
Generates a histogram for the specified items with the specified weighting.
(Defined by AFAggregate.) |
| HistogramAsyncPIServer, TBin |
Generates a histogram for the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.) |
| SummaryPIServer(String, AFSummaryTypes) | Overloaded.
Summarizes the specified items.
(Defined by AFAggregate.) |
| SummaryPIServer(String, AFSummaryTypes, String) | Overloaded.
Summarizes the specified items with the specified weighting.
(Defined by AFAggregate.) |
| SummaryAsyncPIServer(String, AFSummaryTypes, CancellationToken) | Overloaded.
Summarizes the specified items asynchronously.
(Defined by AFAggregate.) |
| SummaryAsyncPIServer(String, AFSummaryTypes, String, CancellationToken) | Overloaded.
Summarizes the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.) |