EssListConnections

Description

EssListConnections() lists all users who are connected to the currently logged in server or application.

Syntax

ESS_FUNC_M EssListConnections (hCtx, pCount, ppUserList);
ESS_HCTX_ThCtx
ESS_PUSHORT_TpCount
ESS_PPUSERINFO_T ppUserList

Parameters

hCtxEssbase API context handle
pCountVariable to receive count of users
ppUserListPointer to an array of user information structures. This array is allocated by the API

Return Value

Returns 0 if successful.

Notes

Access

This function requires the caller to have Supervisor or Application Designer privilege.

Example

ESS_FUNC_M ESS_ListUserConnections (ESS_HCTX_T        hCtx, ESS_HINST_T hInst)
{
        ESS_FUNC_M         sts = ESS_STS_NOERR;
        ESS_USHORT_T      usrcnt;
        ESS_PUSERINFO_T   users;
        sts = EssListConnections(hCtx, &usrcnt,     &users);
        if(!sts)
        EssFree(hInst, users);
        return(sts);
}