# EsbLoadAlias

Description

EsbLoadAlias() creates and permanently loads an alias table for the active database from a structured text file.

Syntax

    EsbLoadAlias (hCtx, AltName, FileName)

    ByVal hCtx     As Long
    ByVal AltName  As String
    ByVal FileName As String

Parameters

hCtx | Essbase VB API context handle.
AltName | Name of an alias table to load.
FileName | Full path name of a structured alias names file on the server.

Return Value

None.

Notes

- This function will not complete successfully if AliasName already exists. To load an alias table of the same name as an existing one, the existing alias table must first be deleted.
- The alias table file format is described in the Application Manager User's Guide.

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 EsbLoadAlias Lib "ESBAPIW" (ByVal hCtx As Long, ByVal AliasName As String, ByVal FileName As String) As Long

    Sub ESB_LoadAlias ()
       Dim sts As Long
       Dim AliasName As String
       Dim FileName As String

       AliasName = "TestAlias"
       FileName = "c:\essbase\test.alt"

       '***********
       ' Load Alias
       '***********
       sts = EsbLoadAlias (hCtx, AliasName, FileName)
    End Sub

See Also

EsbListAliases()
EsbRemoveAlias()
EsbSetActive()