# EsbGetGlobalState

Description

EsbGetGlobalState() gets the server global state structure which contains parameters for system administration.

Syntax

    EsbGetGlobalState (hCtx, pGlobal)

    ByVal hCtx    As Long
          pGlobal As ESB_GLOBAL_T

Parameters

hCtx | Essbase VB API context handle
pGlobal | Buffer to receive a global state structure

Return Value

If successful, returns the current state of the server global state structure in pGlobal.

Notes

- In the pGlobal structure, the statement returns:
  global security status, global login status (enabled/disabled), global default access level, global password validity (in days), global currency enabled flag, global minimum password length, global auto-logout time (in seconds).

Access

This function requires the caller to be a supervisor.

Example

    Declare Function EsbGetGlobalState Lib "ESBAPIW" (ByVal hCtx As Long, Global As ESB_GLOBAL_T) As Long

    Sub ESB_GetGlobalState ()
       Dim sts As Long
       Dim pGlobal As ESB_GLOBAL_T

       '*****************
       ' Get Global State
       '*****************
       sts = EsbGetGlobalState (hCtx, pGlobal)
    End Sub

See Also

EsbSetGlobalState()