OPC Studio User's Guide and Reference
GetAliasInfo Method (_ReadOnlyAliasRepository)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Aliasing.ComTypes Namespace > _ReadOnlyAliasRepository Interface : GetAliasInfo Method
The name of the alias.
Gets information about the specified alias.
Syntax
'Declaration
 
<NotNullAttribute()>
Function GetAliasInfo( _
   ByVal aliasName As String _
) As ValueResult
'Usage
 
Dim instance As _ReadOnlyAliasRepository
Dim aliasName As String
Dim value As ValueResult
 
value = instance.GetAliasInfo(aliasName)
[NotNull()]
ValueResult GetAliasInfo( 
   string aliasName
)
[NotNull()]
ValueResult^ GetAliasInfo( 
   String^ aliasName
) 

Parameters

aliasName
The name of the alias.

Return Value

Returns a value result which contains the OpcLabs.BaseLib.Aliasing.Internal.AliasInfo for the given alias in case of success, or an error in case of failure.
Exceptions
ExceptionDescription

One of the arguments provided to a method is not valid.

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.

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