EssOtlAddMember

Description

EssOtlAddMember() adds a member to the outline and sets the member's attributes.

Syntax

ESS_FUNC_M EssOtlAddMember (hOutline, pMemberInfo, hParent, hPrevSibling, phMember);
ESS_HOUTLINE_T hOutline;
ESS_PMBRINFO_T pMemberInfo;
ESS_HMEMBER_T hParent;
ESS_HMEMBER_T hPrevSibling;
ESS_PHMEMBER_T phMember;

Parameters

hOutlineOutline context handle.
pMemberInfoMember information structure defining the member and its attributes.
hParentHandle of parent. This field is used only if the hPrevSibling field is ESS_NULL.
hPrevSiblingHandle of previous sibling.
phMemberHandle of new member returned from the API.

Return Value

Returns 0 if successful; otherwise one of the following:

OTLAPI_BAD_CONSOL
OTLAPI_BAD_MBRNAME
OTLAPI_ERR_ADDNAMEUSED
OTLAPI_ERR_BADSHARE
OTLAPI_ERR_BADSKIP
OTLAPI_ERR_BADSTORAGE
OTLAPI_ERR_BADSTORAGECATEGORY
OTLAPI_ERR_BADTIMEBAL
OTLAPI_ERR_CURTOOMANYDIMS
OTLAPI_ERR_ILLEGALBOOLEAN
OTLAPI_ERR_ILLEGALCURRENCY
OTLAPI_ERR_ILLEGALDATE
OTLAPI_ERR_ILLEGALNUMERIC
OTLAPI_ERR_ILLEGALTAG
OTLAPI_ERR_LEAFLABEL
OTLAPI_ERR_NOSHAREPROTO
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_MBRINFO_T      MbrInfo; 
ESS_HMEMBER_T      hMemberProfit; 
ESS_HMEMBER_T      hNewMember; 
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, "Profit",
         &hMemberProfit);
}
if (!sts && hMemberProfit) 
{ 
   memset(&MbrInfo, '\0', sizeof(MbrInfo)); 
   strcpy(MbrInfo.szMember, "Inventory"); 
   sts = EssOtlAddMember(hOutline, &MbrInfo,
         ESS_NULL, hMemberProfit, &hNewMember); 
}

See Also

EssOtlAddDimension()
EssOtlDeleteMember()
EssOtlDeleteDimension()
EssOtlSetMemberInfo()
EssOtlFindMember()