EssOtlDeleteAliasTable

Deletes the specified alias table from the outline, clearing all of its entries.

Syntax

ESS_FUNC_M EssOtlDeleteAliasTable (hOutline, pszAliasTable);
ParameterData TypeDescription

hOutline

ESS_HOUTLINE_T

Outline context handle.

pszAliasTable

ESS_STR_T

Name of alias table to delete.

Notes

You cannot delete the default alias table.

Return Value

Returns 0 if successful; otherwise one of the following:

OTLAPI_BAD_ALIASTABLE
OTLAPI_ERR_DELETEDEFALIAS

Example

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

ESS_STS_T          sts = 0;
ESS_HOUTLINE_T     hOutline;
ESS_OBJDEF_T       Object;
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 = EssOtlDeleteAliasTable(hOutline, 
   " Alias Table 1");
}

See Also