EssOtlClearAliasTable

Clears all entries from an existing alias table. The alias table is not deleted.

Syntax

ESS_FUNC_M EssOtlClearAliasTable (hOutline, pszAliasTable);

Parameter	Data Type	Description
hOutline;	ESS_HOUTLINE_T	Outline context handle.
pszAliasTable;	ESS_STR_T	Name of alias table to clear. Use ESS_NULL or "Default" for the default table.

Notes

When clearing aliases from an alias table, language codes associated with the alias table are removed.

Return Value

Returns 0 if successful; otherwise:

OTLAPI_BAD_ALIASTABLE

Example

#include <essapi.h>
#include <essotl.h>

ESS_STS_T          sts = 0;
ESS_OBJDEF_T       Object;
ESS_HOUTLINE_T     hOutline;
ESS_APPNAME_T      szAppName;
ESS_DBNAME_T       szDbName;
ESS_OBJNAME_T      szFileName;

memset(&Object, '\0', sizeof(Object));
Object.hCtx = hCtx;
Object.ObjType = ESS_OBJTYPE_OUTLINE;
strcpy(szAppName, "Sample");
strcpy(szDbName, "Basic");
strcpy(szFileName, "Basic");
Object.AppName = szAppName;
Object.DbName = szDbName;
Object.FileName = szFileName;

sts = EssOtlOpenOutline(hCtx, &Object, ESS_TRUE,
      ESS_TRUE, &hOutline);
if (!sts)
{
   sts = EssOtlClearAliasTable(hOutline, 
   "Default");
}