OPC Studio User's Guide and Reference
GetAliasNames Method (IReadOnlyAliasRepositoryExtension)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Aliasing.Extensions Namespace > IReadOnlyAliasRepositoryExtension Class : GetAliasNames Method
The read-only alias repository that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

Gets names of all aliases in the repository.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function GetAliasNames( _
   ByVal readOnlyAliasRepository As IReadOnlyAliasRepository _
) As ValueResult(Of IEnumerable(Of String))
'Usage
 
Dim readOnlyAliasRepository As IReadOnlyAliasRepository
Dim value As ValueResult(Of IEnumerable(Of String))
 
value = IReadOnlyAliasRepositoryExtension.GetAliasNames(readOnlyAliasRepository)

Parameters

readOnlyAliasRepository
The read-only alias repository that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns a value result which contains a sequence of names of aliases in the repository in case of success, or an error in case of failure.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also