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);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle.

AliasName

ESS_STR_T

Name of alias table to load.

FileName

ESS_STR_T

Full path name of structured alias names file on the server.

Notes

Return Value

None.

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