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



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Aliasing Namespace > IReadOnlyAliasRepository Interface : GetAliasNames Method
The alias filter, which specifies conditions for selecting aliases.

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

Gets names of aliases that satisfy the specified filter.
Syntax
'Declaration
 
<NotNullAttribute()>
Function GetAliasNames( _
   ByVal aliasFilter As AliasFilter _
) As ValueResult(Of IEnumerable(Of String))
'Usage
 
Dim instance As IReadOnlyAliasRepository
Dim aliasFilter As AliasFilter
Dim value As ValueResult(Of IEnumerable(Of String))
 
value = instance.GetAliasNames(aliasFilter)

Parameters

aliasFilter
The alias filter, which specifies conditions for selecting aliases.

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 that satisfy the aliasFilter 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.

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