FindAlias Method (IAliasProvider)

Finds an alias specified by its name.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
Function FindAlias( _
   ByVal aliasName As String _
) As ValueResult

'Usage
 
Dim instance As IAliasProvider
Dim aliasName As String
Dim value As ValueResult
 
value = instance.FindAlias(aliasName)

[JetBrains.Annotations.CanBeNull()]
ValueResult FindAlias( 
   string aliasName
)

[JetBrains.Annotations.CanBeNull()]
ValueResult^ FindAlias( 
   String^ aliasName
)

Parameters

aliasName: The name of the alias.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns a OpcLabs.BaseLib.OperationModel.ValueResult, which contains the value of the alias in case of success, or an error in case of failure. Returns null if the alias has not been found.

This method can return null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentException	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.
System.ArgumentNullException	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.

System.ArgumentException

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.

System.ArgumentNullException

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

Simply not finding the specified alias is not considered an error.

Requirements

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

Reference

IAliasProvider Interface
IAliasProvider Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.