EssLogoutUser

Description

EssLogoutUser() allows a Supervisor or an Application Designer to disconnect another user from an Essbase server.

Syntax

ESS_FUNC_M EssLogoutUser (hCtx, LoginId); 
ESS_HCTX_ThCtx
ESS_LOGINID_TLoginId

Parameters

hCtxEssbase API context handle of user forcing the log out.
LoginIdLogin ID of user to be logged out.

Return Value

None.

Notes

Access

To call this function, you must have Supervisor or Application Designer privilege.

Example

ESS_FUNC_M ESS_LogoutUser (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)
{
if(usrcnt > 0)
{
/***************************************
* Log out first user from the list *
***************************************/
sts = EssLogoutUser(hCtx, users[0].LoginId);
if(!sts)
EssFree(hInst, users);
}
}
return(sts);
}

See Also

EssListConnections()
EssLogout()