AFCollective Methods
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFCollective type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | ApplyChanges |
Save collective changes to the PI AF Server without specifying an event handler.
|
| ApplyChanges(EventHandlerAFProgressEventArgs) |
Save collective changes to the PI AF Server and notify client of progress
using specified event handler.
|
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| Delete |
Delete the collective by removing all members from the collective.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) |
| Equals(AFCollective) |
Indicates whether the current object is equal to another object of the same type.
|
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
| FindPrimary |
Finds the primary member of the collective.
|
| 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.
(Inherited from AFObject.) |
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) |
| 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.) |
| GetStatusDetails |
Gets the detailed collective status information for the collective members from the server.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
| Refresh |
Refreshes the client with any changes that have been made to the collective since loaded.
|
| SwitchMember(AFConnectionPreference) |
The SwitchMember method is used to change the currently connected
member of the collective using default credentials.
|
| SwitchMember(NetworkCredential, AFConnectionPreference) |
The SwitchMember method is used to change the currently connected
member of the collective using the specified credentials.
|
| SwitchMember(Boolean, IWin32Window, AFConnectionPreference) |
The SwitchMember method is used to change the currently connected
member of the collective with a credential prompt if necessary.
|
| ToString |
Returns a String that represents the current object.
(Overrides AFObjectToString.) |