EssOtlGetASOCompressionDimension

Returns the handle of the aggregate storage dimension tagged as Compression.

Syntax

ESS_FUNC_M EssOtlGetASOCompressionDimension (hOutline, phDim);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle (input).
phDim	ESS_PHMEMBER_T	Pointer to a dimension handle (output).

Notes

By default, the compression dimension in aggregate storage databases is the Accounts dimension. To change the compression dimension, use EssOtlSetASOCompressionDimension. Changing the compression dimension triggers a full restructure of the database.

Return Value

Returns 0 if successful.

Example

   ESS_STS_T         sts = ESS_STS_NOERR;
   ESS_HOUTLINE_T    hOutline = ESS_NULL;
   ESS_PMBRINFO_T    pMemberInfo = ESS_NULL;
   ESS_HMEMBER_T     hMember = ESS_NULL;

   /* code to assign hOutline variable omitted */

   if (hOutline)
   {
     sts = EssOtlGetASOCompressionDimension(hOutline, &hMember);
     if (!sts)
     {
        if (hMember)
        {
           sts = EssOtlGetMemberInfo(hOutline, hMember, &pMemberInfo);
           printf("\The ASO compression dimension is: %s\n", pMemberInfo->szMember);
        }
        else
        {
           printf("Outline has no dimension selected for compression\n");
        }
     } 
     else
     {
        printf("Error returned\n");
     }
   }
   else
   {
        printf("NULL outline selected");
   }