EssOtlGetLinkedAttributeAttachLevel

Gets the attachment level for a linked attribute dimension.

Linked attribute dimensions enable periodic comparisons between members in a date-time dimension. Every linked attribute has an association level and an attachment level associated with the attribute dimension definition.

The attachment level is always the longer of the two periods in the periodic comparison represented by a linked attribute dimension. For example, in the linked attribute dimension Quarter by Year, Year is the attachment level, and Quarter is the association level.

Syntax

ESS_FUNC_M EssOtlGetLinkedAttributeAttachLevel (hOutline, hDimMember, psLevel);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle (input).
hDimMember	ESS_HMEMBER_T	Linked attribute dimension member handle (input).
psLevel	ESS_PUSHORT_T	The linked attribute attachment level (output).

Notes

Before you call this function, open the outline in edit or query mode using either EssOtlOpenOutline or EssOtlOpenOutlineQuery.
This function is only applicable when hDimMember is a linked attribute dimension.

Return Value

Returns 0 if successful; otherwise, returns an error.

Example

#include <essapi.h>
#include <essotl.h>
 
ESS_STS_T          sts = 0;
ESS_OBJDEF_T       Object;
ESS_HOUTLINE_T     hOutline;
ESS_HMEMBER        hDimMember;
ESS_USHORT_T       usAttachLevel;
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, "Quarter By Year",
         &hDimMember);
}
 
if (!sts  && hMemberJan)
{
   sts = EssOtlGetLinkedAttributeAttachLevel(hOutline,
         hDimMember, &usAttachLevel);
}