Retrieves information from one or more applications.
Syntax
ESS_FUNC_M EssGetApplicationInfoEx (hCtx, AppName, pusCount, ppAppInfoEx);
Parameter | Data Type | Description |
---|---|---|
hCtx | ESS_HCTX_T | API context handle (logged in). |
AppName | ESS_STR_T | Name of application for which to return information. If NULL, returns information for all applications. |
pusCount | ESS_PUSHORT_T | Number of information structures returned. |
ppAppInfoEx | ESS_APPINFOEX_T | Address of pointer to an array of allocated application info structures. |
Notes
This function can only be called for applications on the server.
The memory allocated for ppAppInfo should be freed using EssFree().
Return Value
If successful, this function returns an array of application information structures in ppAppInfo.
Access
This function requires the caller to have at least read access (ESS_PRIV_READ) to the specified application.
Example
ESS_FUNC_M ESS_GetApplicationInfoEx (ESS_HCTX_T hCtx, ESS_HINST_T hInst) { ESS_FUNC_M sts = ESS_STS_NOERR; ESS_USHORT_T ind; ESS_STR_T AppName; ESS_USHORT_T Count; ESS_PAPPINFOEX_T AppInfoEx = NULL; AppName = ""; sts = EssGetApplicationInfoEx (hCtx, AppName, &Count, &AppInfoEx); if(!sts) { if(AppInfoEx) { printf("\n-----Application Info Ex -----\n\n"); for (ind = 0; ind <Count; ind++) { printf("Name:%s\r\n",AppInfoEx[ind].Name); printf("Server Name:%s\r\n", AppInfoEx[ind].Server); printf("Status:%d\r\n",AppInfoEx[ind].Status); printf("Users Connected:%d\r\n", AppInfoEx[ind].nConnects); printf("\r\n"); } EssFree(hInst, AppInfoEx); } } return (sts); }
See Also