RemoveAliases Method (IAliasRepositoryExtension)

Removes existing aliases in the root namespace from the repository.

Syntax

[Extension()]
[NotNull()]
public static OperationResult RemoveAliases( 
   IAliasRepository aliasRepository,
   string namePattern
)

[Extension()]
[NotNull()]
public:
static OperationResult^ RemoveAliases( 
   IAliasRepository^ aliasRepository,
   String^ namePattern
)

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function RemoveAliases( _
   ByVal aliasRepository As IAliasRepository, _
   ByVal namePattern As String _
) As OperationResult

'Usage
 
Dim aliasRepository As IAliasRepository
Dim namePattern As String
Dim value As OperationResult
 
value = IAliasRepositoryExtension.RemoveAliases(aliasRepository, namePattern)

Parameters

aliasRepository: The alias repository that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
namePattern: The pattern of alias names to be removed.
The value of this parameter cannot 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

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

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

Reference

IAliasRepositoryExtension Class
IAliasRepositoryExtension Members

Documentation Home, Send Documentation Feedback. Technical Support