# EssDisplayAlias

Description

EssDisplayAlias() dumps the contents of an alias table in the active database.

Syntax

    ESS_FUNC_M EssDisplayAlias (hCtx, AliasName, pCount, ppAliases);

ESS_HCTX_T | hCtx
ESS_STR_T | AliasName
ESS_PUSHORT_T | pCount
ESS_MBRALT_T | ppAliases

Parameters

hCtx | Essbase API context handle.
AliasName | Name of alias table.
pCount | Address of variable to receive count of aliases.
ppAliases | Address of pointer to receive member alias table.

Return Value

None.

Notes

- The memory allocated for ppAliases should be freed using EssFree().
- Windows only: The information returned by this command can exceed the ability of Windows to allocate memory. The Windows memory limit is 32 K.

Access

This function requires the caller to have at least read access (ESS_PRIV_READ) to the database, and to have selected it as their active database using EssSetActive().

Example

    ESS_FUNC_M
    ESS_DisplayAlias (ESS_HCTX_T    hCtx)
    {
       ESS_FUNC_M     sts = ESS_STS_NOERR;
       ESS_USHORT_T  Count;
       ESS_USHORT_T  ind;
       ESS_PMBRALT_T Altlist;
       ESS_STR_T     AltName;

       AltName = "TestAlias";

       sts = EssDisplayAlias (hCtx, AltName, &Count, &Altlist);
       if (Count)
       {
          printf ("\r\n-----Alias Contents-----\r\n\r\n");

          for (ind = 0; ind < Count; ind++)
          {
              printf ("%s==>%s\r\n",
                       Altlist [ind].MbrName, Altlist [ind].AltName);
          }
          printf ("\r\n");
       }

      return (sts);
    }

See Also

EssListAliases()