EssLogout
Description
EssLogout() logs a user out from an Essbase server.
Syntax
ESS_FUNC_M EssLogout (hCtx);
Parameters
hCtx | Essbase API context handle to logout.
|
Return Value
None.
Notes
- This function logs out only the login represented by the specified
context handle. No other logins or contexts are affected, even
if using the same user name.
- This function should only be used for login contexts. For
local contexts, use the EssDeleteLocalContext() function.
Access
To call this function, the caller must have previously logged
in successfully using either the EssLogin() or EssAutoLogin
functions.
Example
ESS_FUNC_M
ESS_Logout (ESS_HCTX_T hCtx)
{
ESS_FUNC_M sts = ESS_STS_NOERR;
sts = EssLogout (hCtx);
return(sts);
}
See Also
EssAutoLogin()
EssDeleteLocalContext()
EssGetActive()
EssLogin()
EssLogoutUser()