OPC Studio User's Guide and Reference
ModifyAlias Method (_AliasRepository)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Aliasing.ComTypes Namespace > _AliasRepository Interface : ModifyAlias Method
The name of the alias to be modified.

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

The modified value of the alias. null if the value should not be changed.

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

The modified metadata of the alias. null if the metadata should not be changed.

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

Modifies an existing alias in the repository.
Syntax
'Declaration
 
<NotNullAttribute()>
Function ModifyAlias( _
   ByVal aliasName As String, _
   ByVal value As Object, _
   ByVal aliasMetadata As Object _
) As OperationResult
'Usage
 
Dim instance As _AliasRepository
Dim aliasName As String
Dim value As Object
Dim aliasMetadata As Object
Dim value As OperationResult
 
value = instance.ModifyAlias(aliasName, value, aliasMetadata)

Parameters

aliasName
The name of the alias to be modified.

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

value
The modified value of the alias. null if the value should not be changed.

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

aliasMetadata
The modified metadata of the alias. null if the metadata should not be changed.

The value of this parameter can 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

At least one of value or aliasMetadata must be non-null.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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