Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

9.193 SET_FOR_HEAVY_USAGE

Note
Note: Built-In Function

...

Rules     Usage Options

Sets a function for heavy usage mode

Arguments

No Argument Values.

Return Values

No Return Values.

Technical Notes

  • This Built-In Function allows a function to dynamically change from heavy usage to light usage (and vice-versa). For example:

...

          if (*jobmode = B)

...

             use SET_FOR_HEAVY_USAGE

     else

...

          else
        use SET_FOR_LIGHT_USAGE

...

          endif
  • At every entry or (re)entry the heavy/light usage option is set by the calling parent process, or adopted from a *DIRECT caller, so at every invocation you should positively (re)set the usage option.

  • This Built-In Function executes very quickly and imposes little overhead.

  • Changing a "light usage" function to have a "heavy usage" capability may be more complex than simply adding a use of the SET_FOR_HEAVY_USAGE Built-In Function. Since a heavy usage function's variables and lists retain their values between invocations, more complex entry and/or exit logic may be required.