ModifyAlias Method (_AliasRepository)

Modifies an existing alias in the repository.

Syntax

Visual Basic
C#
C++/CLI

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

[NotNull()]
OperationResult ModifyAlias( 
   string aliasName,
   object value,
   object aliasMetadata
)

[NotNull()]
OperationResult^ ModifyAlias( 
   String^ aliasName,
   Object^ value,
   Object^ aliasMetadata
)

Parameters

aliasName: The name of the alias to be modified.
value: The modified value of the alias. null if the value should not be changed.
aliasMetadata: The modified metadata of the alias. null if the metadata should not be changed.

Return Value

Returns an operation result object indicating success or failure of the operation.

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

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

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

_AliasRepository Interface
_AliasRepository Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.