# EsbGetAlias

Description

EsbGetAlias() gets the active alias table name from the active database for a user.

Syntax

    EsbGetAlias (hCtx, AltName, szName)

    ByVal hCtx    As Long
    ByVal AltName As String
    ByVal szName  As Integer

Parameters

hCtx | Essbase VB API context handle.
AltName | Buffer to receive a name of active alias an table.
szName | Size of the buffer to receive a name of an active alias table.

Return Value

If successful, returns the name of the active alias table in AliasName.

Notes

- If Alias name length is greater that the size of the buffer, the name is truncated.

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 EsbGetAlias Lib "ESBAPIW" (ByVal hCtx As Long, ByVal Name As String, ByVal szName As Integer) As Long

    Sub ESB_GetAlias ()
       Dim sts As Long
       Const szName = 80
       Dim pName As String * szName

       '**********
       ' Get Alias
       '**********
       sts = EsbGetAlias (hCtx, pName, szName)
    End Sub

See Also

EsbListAliases()
EsbSetAlias()
EsbSetActive()