EssOtlQueryGetFirstDimension

Returns the dimension handle of the first dimension in the outline.

Syntax

Parameter	Data Type	Description
hOutline;	ESS_HOUTLINE_T	Handle to the outline (input).
phDim;	ESS_PHMEMBER_T	The dimension handle (output).

Notes

Before you call this function, call EssOtlOpenOutlineQuery to open the outline in query mode.
This function returns the dimension handle of the first dimension in the outline. The handle returned by this function can then be used to call EssOtlGetDimensionNameUniqueness, EssOtlGetCountOfDupMemberNameInDim, or EssOtlIsMemberNameUniqueWithinDim.

Return Value

Returns 0 if successful; otherwise, returns an error.

Example

ESS_FUNC_M ESS_ISUniq()
{
 ESS_STS_T    sts = 0;
 ESS_HOUTLINE_T   hOutline;
 ESS_OBJDEF_T   Object;
 ESS_APPNAME_T   szAppName;
 ESS_DBNAME_T   szDbName;
 ESS_OBJNAME_T   szFileName; 
 ESS_HMEMBER_T   hDim = ESS_NULL;
 ESS_BOOL_T    pbNameUnique = 0;
 

 memset(&Object, '\0', sizeof(Object));
 Object.hCtx =   hCtx;
 Object.ObjType =  ESS_OBJTYPE_OUTLINE;
 strcpy(szAppName, "Demo");
 strcpy(szDbName, "Test"); 
 strcpy(szFileName, "Test");
 Object.AppName =  szAppName;
 Object.DbName =   szDbName;
 Object.FileName =  szFileName;
 

 sts = EssOtlOpenOutlineQuery (hCtx, &Object, &hOutline);
 
 
 
 if (!sts)
 {
  sts = EssOtlQueryGetFirstDimension(hOutline, &hDim);
    
  if (sts)
   printf("EssOtlQueryGetFirstDimension failed sts %ld\n",sts);
 }
 
 
 
 if (!sts)
 {
   sts =  EssOtlIsMemberNameUniqueWithinDim (hOutline, hDim, &pbNameUnique);
   if (sts)
    printf("EssOtlIsMemberNameUniqueWithinDim failed sts %ld\n",sts);
   else
    printf("pbNameUnique is %d\n", pbNameUnique);
 }
 

 return sts;
}