EssRemoveAlias
Description
EssRemoveAlias() permanently removes an alias table from
the active database.
Syntax
ESS_FUNC_M EssRemoveAlias (hCtx, AliasName);
ESS_HCTX_T | hCtx |
ESS_STR_T | AliasName |
Parameters
hCtx | Essbase API context handle. |
AliasName | Name of alias table to remove.
|
Return Value
None.
Notes
- This function can not remove the active alias table or the
default alias table.
- Make sure that no one else is using the same database as the
one you try to remove an alias table from by calling EssListConnections().
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_RemoveAlias (ESS_HCTX_T hCtx)
{
ESS_FUNC_M sts = ESS_STS_NOERR;
ESS_STR_T AliasName;
AliasName = "NewAlias";
sts = EssRemoveAlias(hCtx, AliasName);
if(!sts)
printf("The %s is removed.\r\n",AliasName);
return (sts);
}
See Also
EssClearAliases()
EssListAliases()
EssSetActive()