EssQueryDatabaseMembers

Performs a report-style query to list a selection of database member information.

Syntax

ESS_FUNC_M EssQueryDatabaseMembers (hCtx, mbrQuery);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle.

mbrQuery

ESS_STR_T

Member query string. A query string is a command similar to a report specification. For valid query strings see the Notes topic.

Notes

Return Value

None.

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_STS_T
ESS_GetMembers (ESS_HCTX_T  hCtx,
                ESS_HINST_T hInst
               )
{
   ESS_STS_T        sts = ESS_STS_NOERR;
   ESS_STR_T      mString = NULL;
   
   sts = EssQueryDatabaseMembers (hCtx,
         "<ALLINSAMEDIM Year");

   if (!sts)
      sts = EssGetString (hCtx, &mString);

   while ((!sts) && (mString != NULL))
   {
      printf ("%s\r\n", mString);
      EssFree (hInst, mString);

      sts = EssGetString (hCtx, &mString);
   }
      
   return(sts);
}

See Also