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_ThCtx
ESS_STR_TAliasName
ESS_PUSHORT_TpCount
ESS_MBRALT_TppAliases

Parameters

hCtxEssbase API context handle.
AliasNameName of alias table.
pCountAddress of variable to receive count of aliases.
ppAliasesAddress of pointer to receive member alias table.

Return Value

None.

Notes

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()