# EsbRemoveAlias

Description

EsbRemoveAlias() permanently removes an alias table from the active database.

Syntax

    EsbRemoveAlias (hCtx, AltName)

    ByVal hCtx    As Long
    ByVal AltName As String

Parameters

hCtx | Essbase VB API context handle.
AltName | Name of an alias table to remove.

Return Value

None.

Notes

- "Default" or currently active alias table can not be removed.
- Make sure that no one else is using the same database as the one you try to remove an alias table from by calling EsbListConnections().

Access

This function requires the caller to have access to the database, and to have selected it as their active database using EsbSetActive().

Example

    Declare Function EsbRemoveAlias Lib "ESBAPIW" (ByVal hCtx As Long, ByVal Name As String) As Long

    Sub ESB_RemoveAlias ()
       Dim sts As Long
       Dim Name As String

       Name = "TestAlias"

       '*************
       ' Remove Alias
       '*************
       sts = EsbRemoveAlias (hCtx, Name)
    End Sub

See Also

EsbClearAliases()
EsbListAliases()
EsbLoadAlias()
EsbListConnections()
EsbSetActive()