EssOtlDeleteGenName

Deletes the name of a specific generation within a dimension.

Syntax

ESS_FUNC_M EssOtlDeleteGenName (hOutline, pszDimension, usGen);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle.
pszDimension;	ESS_STR_T	Name of the dimension that contains the generation.
usGen	ESS_USHORT_T	Number of generation for which to delete name. Leaf members are level 0.

Return Value

Returns 0 if successful; otherwise one of the following:

OTLAPI_NO_GENLEVELNAME
OTLAPI_ERR_NOTADIM

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;
ESS_STR_T          Dimension;
ESS_USHORT_T       GenNum;

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);
/***********  Delete Generation Name  ***********/
Dimension = "Year";
GenNum = 2;
if (!sts)
{
   sts = EssOtlDeleteGenName(hOutline, Dimension,
         GenNum);
}