GetState Method (CLIENT)


 9.7A

 

The GetState method retrieves the current state information being used for the client browser environment. The method uses the following format:

 

[label]

{object}.GetState

[GIVING {return}] USING [*StateMask=]{mask}

 

Where:

label

Optional. A Program Execution Label.

object

Required. A CLIENT object.

return

Optional. A Numeric Variable that is returned as a value of zero or one.

mask

Optional. A Numeric Variable or decimal number that identifies a bit mask where each bit corresponds to a client state flag.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. The EOS flag is always cleared.

  2. The ZERO flag is set if the {return} value is zero.

  3. The OVER flag is always cleared.

  4. A value of one is returned when all states for all {mask} state flags are one. Also, note that a value of one is returned if the {mask} has a value of zero. A {return} value of zero is returned when any one state corresponding to a {mask} state flag is zero.

  5. The {mask} bit values define the state flags to be returned.

  6.  

    Mask Value

    Constant

    Definition

    0x0

     

    When there are no state flags specified, the {return} value is always one.

    0x1

    $CLI_STATE_SSL

    This state flag identifies that a client is logged on using a SSL connection.

    0x2

    $CLI_STATE_CORDOVA

    This state flag indicates that Corodva support is used for the client.

    0x4

    $CLI_STATE_JQMOBILE

    This state flag indicates that JQuery Mobile support is used for the client. (10.7)

    0x8

    $CLI_STATE_BOOTSTRAP4

    This state flag indicates that BootStrap 4 support is used for the client. (10.7)

    0x10

    $CLI_STATE_BOOTSTRAP5

    This state flag indicates that Bootstrap 5 and WebView support is used for the client. (10.7)

 

 

See Also: CLIENT, Client Methods, Method Syntax

 



PL/B Language Reference GetMonitorInfo Method (CLIENT) GetWinInfo Method (CLIENT)