AFDatabase Methods
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFDatabase type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddTransfer(String) |
Creates a new AFTransfer without specifying a template.
|
| AddTransfer(String, AFElementTemplate) |
Creates a new transfer based upon the specified template.
|
 | ApplyChanges |
This method applies (saves) all the changes to objects modified by the current user in the database and
makes those changes available to other applications executing under the same user account.
|
| ApplyChanges(AFCheckedOutMode) |
This method applies (saves) the changes to objects in the database according to the specified
AFCheckedOutMode and makes those changes available to other applications executing under
the same user account.
|
| ApplyQueryDate |
Applies the specified query date to the current object and returns an object in the new context.
|
| CheckIn |
This method checks in (commits) all the changes to all objects modified by the current user
in the database by saving all information to persistent storage.
|
| CheckIn(AFCheckedOutMode) |
This method checks in (commits) all the changes to the objects in the database
according to the specified AFCheckedOutMode.
|
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
| FindChangedItems(Boolean, AFTime, AFTime) | Obsolete.
Find all the items that have changed in the AFDatabase.
|
| FindChangedItems(Boolean, Int32, Object, Object) |
Find all the items that have changed in the AFDatabase.
|
| FindChangedItems(AFIdentity, Boolean, AFTime, AFTime) | Obsolete.
Find all the items that have changed in the AFDatabase of the
specified type.
|
| FindChangedItems(AFIdentity, Boolean, Int32, Object, Object) |
Find all the items that have changed in the AFDatabase of the
specified type.
|
| FindCheckedOutItems(Boolean) |
This method finds all the items that are currently checked out in the
AFDatabase.
|
| FindCheckedOutItems(AFCheckedOutMode) |
This method finds the items that are currently checked out in the
AFDatabase according to the specified AFCheckedOutMode.
|
| 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.) |
| GetSecurity |
Gets the AFSecurity information of the specified security item
associated with the object.
|
| 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 database since loaded
without discarding unapplied changes.
|
| Refresh(Boolean) |
Refreshes the client with any changes that have been made to the database since loaded
with an option to discard unapplied changes.
|
| RemoveTransfer |
Removes an existing AFTransfer from the database.
|
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
| UndoCheckOut |
Rolls back all the changes to the database since the last call to the
CheckOut method of each object. Any
changes since the check out will be lost.
|