EsbLogoutUser

Description

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

Syntax
EsbLogoutUser (hCtx, LoginId)
ByVal hCtx    As Long
ByVal LoginId As Long

Parameters

hCtxEssbase VB 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

Declare Function EsbLogoutUser Lib "ESBAPIW" (ByVal hCtx As Long, ByVal LoginId As Long) As Long
Sub ESB_LogoutUser()
   Dim Items As Integer
   Dim UserInfo As ESB_USERINFO_T
   Dim sts As Long
   '*****************
   ' List Connections
   '***************** 
   sts = EsbListConnections(hCtx, Items)
   '*****************
   ' Log out all users
   '***************** 
   For n = 1 To Items
     '*****************************
     ' Get next User Info structure
     ' from the list
     '*****************************
     sts = EsbGetNextItem(hCtx, ESB_USERINFO_TYPE, UserInfo)
     sts = EsbLogoutUser(hCtx, UserInfo.LoginId)
   Next
End Sub 

See Also

EsbListConnections()
EsbLogout()