EsbLogout
Description
EsbLogout() logs a user out from an Essbase server.
Syntax
EsbLogout (hCtx)
ByVal hCtx As Long
Parameters
hCtx | Essbase VB 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 EsbDeleteLocalContext() function.
Access
To call this function, the caller must have previously logged
in successfully using either the EsbLogin() or EsbAutoLogin()
functions.
Example
Declare Function EsbLogout Lib "ESBAPIW" (ByVal hCtx As Long) As Long
Sub ESB_Logout ()
Dim sts As Long
'*******
' Logout
'*******
sts = EsbLogout (hCtx)
End Sub
See Also
EsbAutoLogin()
EsbDeleteLocalContext()
EsbGetActive()
EsbLogin()
EsbLogoutUser()