ILibraryList interface | QSYS API Reference Guide
Estimated reading time: 2 minutes
Defines the contract for managing a library list in the ASNA DataGate client.
Namespace: ASNA.DataGate.Client Assembly: ASNA.QSys.DataGate.Client.dll
Extends: IDisposable
Thread Safety
In DG implementations of ILibraryList , instance members are not guaranteed to be thread safe.
Remarks
This interface provides properties and methods to manage a library list in the ASNA DataGate client. It includes properties to get and set the current system and user libraries as pathnames, and the system and user libraries configuration as pathnames. It also provides methods to enumerate the current system and user libraries as IAdgObject instances, and to add and remove libraries from the library list.
Properties
| Type | Name | Description |
|---|---|---|
| IEnumerable<String> | CurrentSystemLibraries | Gets the current system libraries as pathnames. |
| IEnumerable<String> | CurrentUserLibraries | Gets or sets the current user libraries as pathnames. |
| IEnumerable<String> | SystemLibrariesConfig | Gets or sets the system libraries configuration as pathnames. |
| IEnumerable<String> | UserLibrariesConfig | Gets or sets the user libraries configuration as pathnames. |
Methods
| Signature | Description |
|---|---|
| AddEntry(String, LiblPosition, String) | Adds a library to the library list at a specified position. |
| EnumerateCurrentSystem(AdgEnumerator) | Enumerates the current system libraries as IAdgObject instances. |
| EnumerateCurrentUser(AdgEnumerator) | Enumerates the current user libraries as IAdgObject instances. |
| RemoveEntry(String) | Removes a library from the user portion of the library list. |
void AddEntry(string path, LiblPosition pos, string refLib)
Adds a library to the library list at a specified position.
void AddEntry(string path, LiblPosition pos, string refLib)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | path | The path of the library to add. |
| LiblPosition | pos | The position to add the library at. |
| String | refLib | Optional reference library. |
void EnumerateCurrentSystem(AdgEnumerator enumerator)
Enumerates the current system libraries as IAdgObject instances.
void EnumerateCurrentSystem(AdgEnumerator enumerator)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgEnumerator | enumerator | The enumerator to use. |
void EnumerateCurrentUser(AdgEnumerator enumerator)
Enumerates the current user libraries as IAdgObject instances.
void EnumerateCurrentUser(AdgEnumerator enumerator)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgEnumerator | enumerator | The enumerator to use. |
void RemoveEntry(string path)
Removes a library from the user portion of the library list.
void RemoveEntry(string path)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | path | The path of the library to remove. |