EssListApplications

Lists all applications which are accessible to the caller.

Syntax

ESS_FUNC_M EssListApplications (hCtx, pCount, ppAppList);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle
pCount	ESS_PUSHORT_T	Address of variable to receive count of returned applications
ppAppList	ESS_PPAPPNAME_T	Address of pointer to receive allocated array of application name strings

Notes

The memory allocated for ppAppList must be freed using EssFree().

Return Value

If successful, this function returns a count of the number of accessible applications in pCount, and an array of application name strings in ppAppList. There are 'count' number of items in the array.

Access

This function requires no special privileges; note however that server applications will only be listed if the caller has access to them.

Example

ESS_FUNC_M
ESS_ListApps (ESS_HCTX_T  hCtx,
            ESS_HINST_T hInst
           )
{
   ESS_FUNC_M      sts = ESS_STS_NOERR;
   ESS_PAPPNAME_T strp = NULL;
   ESS_USHORT_T   Items;
   ESS_USHORT_T   ind;
   
   sts = EssListApplications (hCtx, &Items, &strp);
   if (!sts)
   {
      if (Items && strp)
      {
         printf ("Applications availables\r\n");
         for (ind = 0; ind < Items; ind++)
         {
             if (strp [ind] != NULL) 
                printf ("%s\r\n", strp [ind]); 
         }
         EssFree (hInst, strp);
      }
      else
         printf ("\r\nApplication List is Empty\r\n\r\n");
   }
   printf ("\r\n");
   
   return (sts);
}