AFLibraries Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The collection of AFLibrary objects that provides application
and domain specific information that can be loaded into a PISystem.

Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFLibrary
OSIsoft.AFAFNamedCollectionAFLibrary
OSIsoft.AFAFLibraries
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFLibrary
OSIsoft.AFAFNamedCollectionAFLibrary
OSIsoft.AFAFLibraries
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class AFLibraries : AFNamedCollection<AFLibrary>
<SerializableAttribute> Public NotInheritable Class AFLibraries Inherits AFNamedCollection(Of AFLibrary) Dim instance As AFLibraries
[SerializableAttribute] public ref class AFLibraries sealed : public AFNamedCollection<AFLibrary^>
[<SealedAttribute>] [<SerializableAttribute>] type AFLibraries = class inherit AFNamedCollection<AFLibrary> end
The AFLibraries type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFCollection.) | |
| IsDeleted |
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.) | |
| ItemGuid | Returns the item in the collection associated with the passed in ID. (Inherited from AFCollectionT.) | |
| ItemInt32 | Returns the item located at the passed in index. (Inherited from AFCollectionT.) | |
| ItemString |
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.) | |
| ItemIdentity |
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.) | |
| PISystem |
This read-only property allows access to the PISystem
associated with this collection.
(Inherited from AFCollection.) |
Methods
| Name | Description | |
|---|---|---|
| Add(T) |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) | |
| Add(String, String) |
Creates a library from an exported string or file.
| |
| Add(AFDatabase, String) |
Creates a library from the contents of the specified database.
| |
| Add(AFDatabase, String, Boolean) |
Creates a library from the contents of the specified database.
| |
| Clear |
Removes all items from the collection.
(Inherited from AFCollectionT.) | |
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.) | |
| Contains(T) |
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.) | |
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.) | |
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
(Inherited from AFCollectionT.) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.) | |
| 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 AFCollection.) | |
| 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.
(Inherited from AFCollectionT.) | |
| Refresh |
Refresh the collection to make sure it's list of items is up-to-date.
| |
| Remove(Guid) |
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.) | |
| Remove(T) |
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.) | |
| Remove(String) |
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.) | |
| RemoveAt |
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.) | |
| Sort |
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.) | |
| Sort(IComparerT) |
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.) | |
| Sort(Int32, Int32, IComparerT) |
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.) | |
| ToString |
Returns a String that represents the current object.
(Inherited from AFCollection.) |
Remarks
Each PI AF Server has its own collection of libraries, which are present on the server. This collection is retrieved from the server each time it is acquired from the PISystem.
An AFLibrary is a mechanism to provide application and domain specific information that can be loaded into a database.
Examples
// This example will create a new library and import it into a new Database. // Create a new Database on the default PI System PISystems myPISystems = new PISystems(); PISystem myPISystem = myPISystems.DefaultPISystem; // Create a new library AFDatabase myLibDB = myPISystem.Databases.Add("MyLibDB"); AFElementTemplate myElemTemplate = myLibDB.ElementTemplates.Add("MyElemTemplate"); AFAttributeTemplate myAttributeTemplate = myElemTemplate.AttributeTemplates.Add("MyAttribute1"); myLibDB.CheckIn(); AFLibrary library = myPISystem.Libraries.Add(myLibDB, "Standard"); library.Description = "This is the standard library."; // Get the standard Library library = myPISystem.Libraries["Standard"]; Console.WriteLine("Current number of Libraries = {0}", myPISystem.Libraries.Count); AFDatabase myDB = myPISystem.Databases.Add("MyDB"); if (library != null) { // Display Library information Console.WriteLine("Description of Library = {0}", library.Description); Console.WriteLine("Name of Library = {0}", library.Name); Console.WriteLine("UniqueID of Library = {0}", library.UniqueID); // Import the Library into the Database library.Import(myDB); }
' This example will create a new library and import it into a new Database. ' Create a new Database on the default PI System Dim myPISystems As New PISystems() Dim myPISystem As PISystem = myPISystems.DefaultPISystem ' Create a new library Dim myLibDB As AFDatabase = myPISystem.Databases.Add("MyLibDB") Dim myElemTemplate As AFElementTemplate = myLibDB.ElementTemplates.Add("MyElemTemplate") Dim myAttributeTemplate As AFAttributeTemplate = myElemTemplate.AttributeTemplates.Add("MyAttribute1") myLibDB.CheckIn() Dim library As AFLibrary = myPISystem.Libraries.Add(myLibDB, "Standard") library.Description = "This is the standard library." ' Get the standard Library library = myPISystem.Libraries("Standard") Console.WriteLine("Current number of Libraries = {0}", myPISystem.Libraries.Count) Dim myDB As AFDatabase = myPISystem.Databases.Add("MyDB") If library IsNot Nothing Then ' Display Library information Console.WriteLine("Description of Library = {0}", library.Description) Console.WriteLine("Name of Library = {0}", library.Name) Console.WriteLine("UniqueID of Library = {0}", library.UniqueID) ' Import the Library into the Database library.Import(myDB) End If
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.