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
ParameterDescription

hCtx

VB API context handle

pGlobal

Buffer to receive a global state structure

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).

Return Value

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

Access

This function requires the caller to be an administrator.

Example

Declare Function EsbGetGlobalState Lib "ESBAPIN" (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