$Setg_Subsys

Set subsystem-wide global

Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Setg_Subsys function is the SetGlobal subroutine.

This function allows a user to set the value of a Model 204 "global variable" which has a subsystem-wide scope. These are used for the value of the $GetG function or dummy string ("?&") substitution. The order in which the different scopes of global variables are searched can be controlled using $SirParm parameters: for $GetG, with 'GETGSYS', and for dummy strings, with 'DUMMYSYS'.

The $Setg_Subsys function accepts three arguments and returns zero, indicating success, or a number indicating the cause of error, if there is one.

The first argument is the name of the global variable to be set. This is an optional argument; it defaults to the null string.

The second argument is the value to which the global variable is to be set. This is an optional argument; it defaults to the null string.

The third argument is the name of the subsystem that the variable is associated with. This is an optional argument if the $function is invoked from within a subsystem; it defaults to the null string. A non-null subsystem name is required if the $function is invoked from outside a subsystem. If invoked from a subsystem and the third argument is null, the name of the subsystem is used.

System administrator privileges are required to invoke this $function, unless the third argument is omitted or is the null string, and the $function is invoked from a precompiled procedure; in that case, no privileges are required, and the subsystem name used is the active subsystem.

Syntax

%rc = $Setg_Subsys([glob_name], [value], subsys_name)

%rc is set to 0 or to an error indicator.

Return codes

0 - No errors 1 - Not system administrator 2 - Insufficient storage 3 - Subsystem name missing

Usage notes

• This function can be used to set a global variable which is used for all users of a subsystem. The value can be set during Model 204 initialization (that is, in the CCAIN stream), so values can be calculated once, rather than every time a user enters the subsystem. For example, the following request can be run from CCAIN:

  OPEN CALENDAR BEGIN %DAYS STRING LEN 100 %X FLOAT %DAYS = D: FOR EACH VALUE OF DAY %DAYS = %DAYS WITH ' ' WITH VALUE IN D END FOR %X = $Setg_Subsys('DAYS', %DAYS, 'TIMESHEET') END

  Then, during execution of the TIMESHEET subsystem, the global variable DAYS can be used to obtain the days of the week.

  Also, since there is one shared subsystem global table for the entire system, a smaller GTBL value for each user can be achieved than if the global values are set with user global variables.
• The order in which the different scopes of global variables are searched can be controlled using $SirParm parameters: for $Getg, with 'GETGSYS', and for dummy strings, with 'DUMMYSYS'. Here is an example to show the effects of DUMMYSYS and GETGSYS; assume the following procedure is executed in the CCAIN input stream:

  BEGIN %X = $Setg_Subsys('JUNK', 'HELLO', 'MY_SUBSYS') END

  And assume the login procedure of MY_SUBSYS contains the following requests:

  BEGIN %Y = $SETG('JUNK', 'GOODBYE') END BEGIN PRINT '?&amp.JUNK' PRINT $GETG('JUNK') END

  Then here are various command streams, and their results:

  1. DUMMYSYS=0, GETGSYS=0:

     BEGIN %X FLOAT %X = $SirParm('DUMMYSYS', 0) %X = $SirParm('GETGSYS', 0) END MY_SUBSYS

     Produces the following print lines:

     GOODBYE GOODBYE

  
  

  2. DUMMYSYS=0, GETGSYS=1:

     BEGIN %X FLOAT %X = $SirParm('DUMMYSYS', 0) %X = $SirParm('GETGSYS', 1) END MY_SUBSYS

     Produces the following print lines:

     GOODBYE HELLO

  
  

  3. DUMMYSYS=1, GETGSYS=0:

     BEGIN %X FLOAT %X = $SirParm('DUMMYSYS', 1) %X = $SirParm('GETGSYS', 0) END MY_SUBSYS

     Produces the following print lines:

     HELLO GOODBYE

  
  

  4. DUMMYSYS=1, GETGSYS=1:

     BEGIN %X FLOAT %X = $SirParm('DUMMYSYS', 1) %X = $SirParm('GETGSYS', 1) END MY_SUBSYS

     Produces the following print lines:

     HELLO HELLO

• The current values of subsystem globals can be retrieved using $Setg_Subsys_List.
• Retrieval of subsystem global variables is highly efficient; updates, however, are not, so use this $function appropriately.

Products authorizing $Setg_Subsys

• Sirius functions
• Janus Web Server