RenameAlias Method (IAliasRepository)

Renames an existing alias in the repository.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function RenameAlias( _
   ByVal oldAliasName As String, _
   ByVal newAliasName As String _
) As OperationResult

'Usage
 
Dim instance As IAliasRepository
Dim oldAliasName As String
Dim newAliasName As String
Dim value As OperationResult
 
value = instance.RenameAlias(oldAliasName, newAliasName)

[NotNull()]
OperationResult RenameAlias( 
   string oldAliasName,
   string newAliasName
)

[NotNull()]
OperationResult^ RenameAlias( 
   String^ oldAliasName,
   String^ newAliasName
)

Parameters

oldAliasName: Name of the existing alias to be renamed.
The value of this parameter cannot be null (Nothing in Visual Basic).
newAliasName: New name of the alias being renamed.
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

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

We use the word "rename" and not "move", because in the simplified case, there are no namespaces, and there is no "move" then.

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

IAliasRepository Interface
IAliasRepository 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.