# EsbGetApplicationState

Description

EsbGetApplicationState() gets an Application's state structure, which contains user-configurable parameters for the Application.

Syntax

    EsbGetApplicationState (hCtx, AppName, pAppState)

    ByVal hCtx      As Long
    ByVal AppName   As String
          pAppState As ESB_PAPPSTATE_T

Parameters

hCtx | Essbase VB API context handle.
AppName | Application name.
pAppState | Buffer to receive an application state structure.

Return Value

If successful, this function returns an application state structure in pAppState.

Notes

- This function cannot be called for local applications; it can only be called for applications on the server.

Access

This function requires the caller to have access to the specified application.

Example

    Declare Function EsbGetApplicationState Lib "ESBAPIW" (ByVal hCtx As Long, ByVal AppName As String, AppState As ESB_APPSTATE_T As Long

    Sub ESB_GetApplicationState ()
       Dim sts As Long
       Dim AppName As String
       Dim AppState As ESB_APPSTATE_T

       AppName = "Sample"

       '********************************
       ' Get Application State structure
       '********************************
       sts = EsbGetApplicationState (hCtx, AppName,
       AppState)
    End Sub

See Also

EsbGetApplicationInfo()
EsbGetDatabaseState()
EsbSetApplicationState()