ModifyAlias Method (IAliasRepositoryExtension)

Modifies an existing alias value in the repository, keeping its alias metadata unchanged.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function ModifyAlias( _
   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.ModifyAlias(aliasRepository, aliasName, value)

[Extension()]
[JetBrains.Annotations.NotNull()]
public static OperationResult ModifyAlias( 
   IAliasRepository aliasRepository,
   string aliasName,
   object value
)

[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static OperationResult^ ModifyAlias( 
   IAliasRepository^ aliasRepository,
   String^ aliasName,
   Object^ 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 the alias to be modified.
The value of this parameter cannot be null (Nothing in Visual Basic).
value: The modified value of the alias.
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

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