EssGetMemberInfo

Description

EssGetMemberInfo() gets a structure containing information about a specific member in the active database outline.

Syntax

ESS_FUNC_M EssGetMemberInfo (hCtx, MbrName, ppMbrInfo);
ESS_HCTX_ThCtx
ESS_STR_TMbrName
ESS_PPMEMBERINFO_T ppMbrInfo

Parameters

hCtxEssbase API context handle.
MbrNameMember name.
ppMbrInfoAddress of pointer to receive allocated member information structure.

Return Value

If successful, this function returns an allocated member information structure, ppMbrInfo. If a member has no parent, this function returns an empty string in the ParentMbrName field of the ESS_MEMBERINFO_T structure.

Notes

Access

This function requires the caller to have at least read access (ESS_PRIV_READ) to the database, and to have selected it as their active database using EssSetActive().

Example

ESS_FUNC_M
ESS_GetMbrInfo (ESS_HCTX_T  hCtx,
                ESS_HINST_T hInst
               )
{
   ESS_FUNC_M         sts = ESS_STS_NOERR;
   ESS_MEMBERINFO_T  *pMbrInfo = NULL;
   sts = EssGetMemberInfo(hCtx, "Profit",
                &pMbrInfo);
   if (!sts)
   {      
      if (pMbrInfo)
      {
         EssFreeStructure(hCtx, structId, count, structPtr);
      }
   }
   return (sts);
}

See Also

EssCheckMemberName()
EssFreeStructure()
EssGetMemberCalc()
EssQueryDatabaseMembers()
EssSetActive()