EsbListRequests

Returns information about active sessions and requests.

Syntax

  EsbListRequests (hCtx, UserName, AppName, DbName, Items)
  ByVal hCtx     As Long
  ByVal UserName As String
  ByVal AppName  As String
  ByVal DbName   As String
        Items    As Long

Parameter	Description
hCtx	Context handle
AppName	Application name
DbName	Database name
UserName	User name
Items	Number of index and data files returned

Notes

A session is the time in seconds between a user's login and logout.
A request is a query sent to Essbase by a user or by another process; for example, starting an application or restructuring a database outline. Each session can process only one request at a time; therefore, sessions and requests have a one-to-one relationship.
Some of the listed requests may have been recently terminated, but are still listed as active due to network delay.
This function returns information on requests and sessions initiated by the process specified by the UserName, AppName, and DbName. If these parameters are null or empty, then all the processes in the system are listed. This function returns the number of current requests and one ESB_REQUESTINFO_T structure for each request.
After you call EsbListRequests(), call EsbGetNextItem(), using ESB_REQUESTINFO_TYPE, to retrieve the request information structures that you want.

Return Value

If successful, returns a count of the number of users in Items, and generates a list of users with access to the specified application and database that is accessible using EsbGetNextItem().

Access

This function requires no special privileges.

Example

Declare Function EsbListRequests Lib "ESBAPIN" (ByVal hCtx As Long, ByVal UserName As String, ByVal AppName As String, ByVal DbName As String, pItems As Integer) As Long
  
Sub ESB_ListRequests() 
     Dim Items As Integer 
     Dim ReqInfo As ESB_REQUESTINFO_T 
     Dim sts As Long 
     Dim pAccess As Integer 
  
     'sts = EsbSetActive(hCtx, AppName, DbName, pAccess) 
     'sts = EsbDefaultCalc(hCtx) 
     '************* 
     ' List Requests 
     '************* 
     sts = EsbListRequests(hCtx, UserName, AppName, DbName, Items) 
     Debug.Print "EsbListRequests = " & sts & " " & Items 
      
     For n = 1 To Items 
       '******************** 
       ' Get next Request Info 
       ' from the list 
       '******************** 
       sts = EsbGetNextItem(hCtx, ESB_REQUESTINFO_TYPE, ReqInfo) 
       Debug.Print "EsbGetNextItem = " & sts & " " & ReqInfo.LoginId & " " & 
ReqInfo.DbRequestCode 

     Next 
  End Sub