EssOtlDeleteDimension

Description

EssOtlDeleteDimension() deletes a dimension from the outline. The call also specifies a member of the dimension being deleted from which to keep data when the outline is restructured.

Syntax

ESS_FUNC_M EssOtlDeleteDimension (hOutline, hMember, pszDataMbr);
ESS_HOUTLINE_T hOutline
ESS_HMEMBER_T hMember
ESS_STR_T pszDataMbr

Parameters

hOutlineOutline context handle.
hMemberHandle of member to delete.
pszDataMbrMember name in the dimension to be deleted from which data will be saved when the outline is restructured. If this field is ESS_NULL, the dimension is used.

Return Value

Returns 0 if successful; otherwise:

OTLAPI_ERR_ADDDELETEDIMDYNAMICCALC
OTLAPI_ERR_NOTIMEDIM

Notes

Example

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

ESS_STS_T          sts = 0;
ESS_OBJDEF_T       Object;
ESS_HOUTLINE_T     hOutline;
ESS_HMEMBER_T      hMemberScenario;
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, "Scenario",
   &hMemberScenario);
}

if (!sts && hMemberScenario)
{
   sts = EssOtlDeleteDimension(hOutline, 
   hMemberScenario, "Actual");
}

SeeAlso

EssOtlDeleteMember()
EssOtlAddDimension()
EssOtlAddMember()
EssOtlFindMember()
EssOtlGetMemberInfo()