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



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Aliasing.ComTypes Namespace > _AliasRepository Interface : RemoveAliases Method
The namespace in which the aliases to be removed reside.

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

The pattern of alias names to be removed.

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

Removes existing aliases from the repository.
Syntax
'Declaration
 
<NotNullAttribute()>
Function RemoveAliases( _
   ByVal aliasNamespace As String, _
   ByVal namePattern As String _
) As ValueResult
'Usage
 
Dim instance As _AliasRepository
Dim aliasNamespace As String
Dim namePattern As String
Dim value As ValueResult
 
value = instance.RemoveAliases(aliasNamespace, namePattern)
[NotNull()]
ValueResult RemoveAliases( 
   string aliasNamespace,
   string namePattern
)
[NotNull()]
ValueResult^ RemoveAliases( 
   String^ aliasNamespace,
   String^ namePattern
) 

Parameters

aliasNamespace
The namespace in which the aliases to be removed reside.

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

namePattern
The pattern of alias names to be removed.

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

Return Value

Returns value result which contains the number of aliases removed in case of success, or an error in case of failure.

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 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