SetAlias Method (IAliasRepository)

Sets an alias value, and optionally its metadata, in the repository.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function SetAlias( _
   ByVal aliasName As String, _
   ByVal value As Object, _
   ByVal aliasMetadata As AliasMetadata _
) As OperationResult

'Usage
 
Dim instance As IAliasRepository
Dim aliasName As String
Dim value As Object
Dim aliasMetadata As AliasMetadata
Dim value As OperationResult
 
value = instance.SetAlias(aliasName, value, aliasMetadata)

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

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

Parameters

aliasName: The name of alias to be set.
The value of this parameter cannot be null (Nothing in Visual Basic).
value: The value of the alias.
The value of this parameter cannot be null (Nothing in Visual Basic).
aliasMetadata: The modified metadata of the alias. null if the metadata should not be changed or, if a new alias is being added, to give it a default metadata.
The value of this parameter can 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.

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.