EssOtlGetAggLevelUsage

Returns the applied view selection properties on stored hierarchies.

Syntax

ESS_FUNC_M EssOtlGetAggLevelUsage (hOutline, hMember, pAgglevelUsage);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle (input).
hMember	ESS_HMEMBER_T	Member handle (input).
pAgglevelUsage	ESS_PSHORT_T	One of the Level Usage Constants listed in EssOtlSetAggLevelUsage documentation (output).

Notes

This function is applicable only to Release 9.3 or higher aggregate storage databases.

Return Value

Returns 0 if successful.

Example

   ESS_STS_T         sts = ESS_STS_NOERR;
   ESS_HOUTLINE_T    hOutline = ESS_NULL;
   ESS_HMEMBER_T     hMember = ESS_NULL;
   ESS_SHORT_T       sAggLevelUsage = 0;

   /* code to assign hOutline variable omitted */
   /* code to assign hMember variable omitted */

   if (hOutline && hMember)
   {
       sts = EssOtlGetAggLevelUsage (hOutline, hMember, &sAggLevelUsage);
 if (sts)
   printf("Error (%ld) getting AggLevelUsage\n", sts);
 else
         printf("AggLevelUsage is: %d ", sAggLevelUsage);
         switch (sAggLevelUsage)
         {
         case ESS_AGGLEVELUSAGE_NOTSET : 
                  printf("(not set)\n");
                  break;
         case ESS_AGGLEVELUSAGE_DEFAULT : 
                  printf("(Default)\n");
                  break;
         case ESS_AGGLEVELUSAGE_ALL : 
                  printf("(All levels considered)\n");
                  break;
         case ESS_AGGLEVELUSAGE_NOAGGREGATION : 
                  printf("(Do not aggregate)\n");
                  break;
         case ESS_AGGLEVELUSAGE_BOTTOMONLY : 
                  printf("(Bottom level only considered)\n");
                  break;
         case ESS_AGGLEVELUSAGE_TOPONLY : 
                  printf("(Top level only considered)\n");
                  break;
         case ESS_AGGLEVELUSAGE_BOTTOMTOP : 
                  printf("(Never aggregate intermediate levels)\n");
                  break;
         case ESS_MULTIPLE_HIERARCHY_IS_ENABLED : 
 printf("(Error: Multiple hierarchies - hierarchy members are gen=2)\n");
                  break;
         case ESS_MULTIPLE_HIERARCHY_NOT_ENABLED : 
       printf("(Error: Single hierarchy - hierarchy member is gen=1)\n");
                  break;
         case ESS_NOT_HIERARCHY_MEMBER : 
    printf("(Error: This member does not carry agglevel information)\n");
                  break;
         default: printf("(Unrecognized response)\n");                                
      }
   }
   else
   {
       if (!hOutline)
          printf("Outline not provided\n");
       if (!hMember)
          printf("Member not provided\n");
   }