OPC Studio User's Guide and Reference
AddAlias Method (IAliasRepositoryExtension)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Aliasing.Extensions Namespace > IAliasRepositoryExtension Class : AddAlias Method
The alias repository that will perform the operation.

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

The name of alias to be added.

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

The value of the alias to be added

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

Adds a new alias to the repository, with default alias metadata.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function AddAlias( _
   ByVal aliasRepository As IAliasRepository, _
   ByVal aliasName As String, _
   ByVal value As Object _
) As OperationResult
'Usage
 
Dim aliasRepository As IAliasRepository
Dim aliasName As String
Dim value As Object
Dim value As OperationResult
 
value = IAliasRepositoryExtension.AddAlias(aliasRepository, aliasName, value)

Parameters

aliasRepository
The alias repository that will perform the operation.

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

aliasName
The name of alias to be added.

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

value
The value of the alias to be added

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

Return Value

Returns an operation result object indicating success or failure of the operation.

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

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.

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