Difference: 0LASubrClientGetConstant (7 vs. 8)

Revision 82020-01-28 - JeanNeron

Line: 1 to 1

META TOPICPARENT	name="APPXRuntimeSubroutineAPI"

.CLIENT GET CONSTANT

Line: 8 to 8

Usage:

      PASS         <client_value>             FIELD            SHARE? Y
      PASS         <client_name>              FIELD            SHARE? N

Added:

>
>

PASS <get_current> FIELD SHARE? N

GOSUB --- .CLIENT GET CONSTANT

- Check for errors IF --- .CLIENT GET CONSTANT NE

Line: 21 to 22

<client_name> is the name of the client constant for which you want the value (Required). This is case sensitive, see the list below.

Added:

>
>

<get_current> is an optional flag to get the current client settings vs the settings at startup (Optional). This is only available in Release 5.5. and higher. PASS any non blank value to refresh the values from current client settings.

If the field you passed is too short to contain the data, --- .CLIENT GET CONSTANT will be set to "Data was truncated". If the client constant does not exist, --- .CLIENT GET CONSTANT will be set to "Const. name not found".

The list of client constants you can query varies from release to release. To see the current constants, from the main Appx menu, choose System Administration/System Setup/Version Info from the pull down menu, then click the Environment Variables button. Everything that begins with 'client.' can be queried with this subroutine. Do not include the leading 'client.' in <client_name>, eg, to get the value of 'client.os.name' you would pass 'os.name'. To get the value of an environment variable, see .ENV GET ENV VARIABLE.

Changed:

<
<

NOTE: The values retrieved are not coming directly from the client. The APPX engine stores them during the initial startup of the client, and does not update them if they change while the client is running. Thus these constant variables will NOT reflect changes made to them after startup.

>
>

NOTE: Unless you PASS the optional <get_current> argument, the values retrieved will not come directly from the client. The APPX engine stores them during the initial startup of the client, and does not update them if they change while the client is running. Thus these constant variables will NOT reflect changes made to them after startup unless you PASS the optional <get_current> parameter (5.5 & higher only). If you PASS <get_current>, then the values stored by the engine will also be updated, and the next time you call this API, you will get those values, not necessarily the values at startup.

Here is a list of client constants available as of Release 5.1:

View topic | History: r9 < r8 < r7 < r6 | More topic actions...