EssOtlGetDimensionNameUniqueness

Returns the dimension's member-name uniqueness setting.

Syntax

ESS_FUNC_M EssOtlGetDimensionNameUniqueness (hOutline, hDim, pbNameUnique);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle (input).
hDim	ESS_HMEMBER_T	Member handle of the dimension root member (input).
pbNameUnique	ESS_PBOOL_T	The dimension member name uniqueness setting (output). If TRUE, the dimension cannot have duplicate member names.

Notes

Call EssOtlFindMember to set up the ESS_HMEMBER_T (hDim) variable.

Return Value

Returns 0 if successful; otherwise, returns an error.

Example

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

 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 = EssOtlOpenOutline(hCtx, &Object, ESS_TRUE, 
  ESS_TRUE, &hOutline);
 
 if (!sts)
 {
  sts = EssOtlFindMember(hOutline, "Year",&hDim);
    
  if (sts)
   printf("EssOtlFindMember failed sts %ld\n",sts);
 }
 
 /*Get the dimension's, Year, member-name uniqueness setting */
 if (!sts)
 {
  sts = EssOtlGetDimensionNameUniqueness (hOutline, hDim, &pbNameUnique);
 
  if (sts)
   printf("EssOtlGetDimensionNameUniqueness failed sts %ld\n",sts);
  else
   printf("Dimension Year has Member Name Uniqueness value: %ld\n", pbNameUnique);
 }
 
 if (!sts)
 {
  sts = EssOtlFindMember(hOutline, "Product",&hDim);
    
  if (sts)
   printf("EssOtlFindMember failed sts %ld\n",sts);
 }
 
 if (!sts)
 {
  /*set Product to prohibit duplicate (non-unique) member names*/
  pbNameUnique = ESS_TRUE;
  sts = EssOtlSetDimensionNameUniqueness (hOutline, hDim, pbNameUnique);
 
  if (sts)
   printf("EssOtlSetDimensionNameUniqueness failed sts %ld\n",sts);
  else
   printf("Dimension Product has Member Name Uniqueness value: %ld\n", pbNameUnique);
 }
 
 return sts;
 
}