EssLoadAlias

Description

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

Syntax
ESS_FUNC_M EssLoadAlias (hCtx, AliasName, FileName);
ESS_HCTX_ThCtx
ESS_STR_TAliasName
ESS_STR_TFileName

Parameters

hCtxEssbase API context handle.
AliasNameName of alias table to load.
FileNameFull path name of structured alias names file on the server.

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_LoadAlias (ESS_HCTX_T  hCtx)
{
   ESS_FUNC_M     sts = ESS_STS_NOERR;
   ESS_STR_T     TableName;
   ESS_STR_T     FileName;
   TableName = "NewAlias";
   FileName  = "NEW.ALT";
   sts = EssLoadAlias (hCtx, TableName, FileName);
   
  return (sts);
}

See Also

EssListAliases()
EssSetActive()