EssOtlSetMemberAlias

Sets the default member alias for the specified member in the specified alias table.

Syntax

ESS_FUNC_M EssOtlSetMemberAlias (hOutline, hMember, pszAliasTable, pszAlias);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle.
hMember	ESS_HMEMBER_T	Handle of member to set the alias for.
pszAliasTable	ESS_STR_T	Alias table to set the alias for. If this parameter is ESS_NULL, the default alias table is used.
pszAlias	ESS_STR_T	Alias.

Notes

Use EssOtlDeleteMemberAlias() to remove an alias.

Return Value

Returns 0 if successful; otherwise one of the following::

OTLAPI_BAD_ALIASTABLE
OTLAPI_ERR_ILLEGALDEFALIAS
OTLAPI_ERR_ILLEGALCOMBOALIAS
OTLAPI_ERR_ILLEGALALIASSTRING
OTLAPI_ERR_DUPLICATEALIAS

Example

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

ESS_STS_T          sts = 0;
ESS_OBJDEF_T       Object;
ESS_HOUTLINE_T     hOutline;
ESS_HMEMBER_T      hMember;
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 = EssOtlFindMember(hOutline, "Year",
         &hMember);
}

if (!sts  && hMember)
{
   sts = EssOtlSetMemberAlias(hOutline,
         hMember, ESS_NULL, "Time Dimension");
}