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_T | hCtx |
ESS_STR_T | AliasName |
ESS_STR_T | FileName |
Parameters
hCtx | Essbase API context handle. |
AliasName | Name of alias table to load.
|
FileName | Full path name of structured alias names file on the server.
|
Return Value
None.
Notes
- This function cannot complete successfully if AliasName
already exists. Before you can load an alias table with the same
name as an existing table, you must delete the existing alias
table.
- The alias table file format is described in the Application
Manager User's Guide.
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()