Permanently removes all alias tables for the active database.
Syntax
ESS_FUNC_M EssClearAliases (hCtx);
Parameter | Data Type | Description |
---|---|---|
hCtx | ESS_HCTX_T | API context handle. |
Notes
This function can not remove the active alias table or the default alias table.
Use EssSetAlias() to set an active alias to "default" prior to using this API function.
Make sure that no one else is using the same database as the one you try to clear alias tables from by calling EssListConnections().
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_ClearAliases (ESS_HCTX_T hCtx) { ESS_FUNC_M sts = ESS_STS_NOERR; sts = EssClearAliases(hCtx); if(!sts) printf("All alias tables are removed.\r\n"); return (sts); }
See Also