# EssOtlRenameAliasTable

Description

EssOtlRenameAliasTable() renames an existing alias table.

Syntax

    ESS_FUNC_M EssOtlRenameAliasTable (hOutline, pszAliasTable, pszNewAliasTable);

ESS_HOUTLINE_T | hOutline
ESS_STR_T | pszAliasTable
ESS_STR_T | pszNewAliasTable

Parameters

hOutline | Outline context handle.
pszAliasTable | Name of alias table to rename.
pszNewAliasTable | New name for alias table.

Return Value

Returns 0 if successful; otherwise one of the following:
OTLAPI_BAD_ALIASTABLE
OTLAPI_ERR_RENAMEDEFALIAS
OTLAPI_ERR_ALIASTABLENAME
OTLAPI_ERR_ALIASTABLEEXISTS

Notes

- The default alias table cannot be renamed from "Default".

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 = EssOtlRenameAliasTable(hOutline,
             "Alias Table 2","2nd alias table");
    }

See Also

EssOtlCreateAliasTable()
EssOtlCopyAliasTable()
EssOtlClearAliasTable()
EssOtlDeleteAliasTable()