WorkStack: Difference between revisions

From BR Wiki
Jump to navigation Jump to search
(Created page with "The '''WorkStack''' specification allows you to change the size of the work stack, which keeps track of temporary variables that are passed and localized during user- defined ...")
 
 
(4 intermediate revisions by the same user not shown)
Line 9: Line 9:
*ENV$("STATUS.STACKS.WORKSTACK.AVAILABLE")
*ENV$("STATUS.STACKS.WORKSTACK.AVAILABLE")
*ENV$("STATUS.STACKS.WORKSTACK.MAX_USAGE")
*ENV$("STATUS.STACKS.WORKSTACK.MAX_USAGE")
Also the command '''STATUS STACKS''' shows the current stack settings.


====Syntax====
====Syntax====
[[Image:Workstack.png]]
[[Image:Workstack.png]]


====Start-up Default====
====Start-up Default ====
WorkStack 2000
WorkStack 500000  (version 4.3+)


====Parameter====
====Parameter====
"Integer" is a whole number that represents the number of bytes that the work stack may contain. It must be greater than 499.
"Integer" is a whole number that represents the number of bytes that the work stack may contain. It must be greater than 499 and may be arbitrarily high (e.g. up to 99 million bytes).


====Technical Considerations====
====Technical Considerations====
# WorkStack may be specified only in the [[BRConfig.sys]] file; it is '''not''' valid with [[Config]].
# WorkStack may be specified only in the [[BRConfig.sys]] file; it is '''not''' valid with the [[Config]] command.
# The amount of user memory available depends upon the amount of memory used by all the stacks together. Be sure to account for the sizes of the other stacks when you use the WorkStack specification.
# The amount of stack memory available depends upon several variables. You may need to monitor your memory usage to determine the optimal stack size for your needs.


<noinclude>
<noinclude>
[[Category:Config]]
[[Category:Config]]
</noinclude>
</noinclude>

Latest revision as of 00:04, 29 June 2015

The WorkStack specification allows you to change the size of the work stack, which keeps track of temporary variables that are passed and localized during user- defined function calls, concatenations, or complex expressions.

Checking Values

The following environmental variables may be used to check your workstacks during a BR! session.

  • ENV$("STATUS.STACKS.WORKSTACK")
  • ENV$("STATUS.STACKS.WORKSTACK.MAX")
  • ENV$("STATUS.STACKS.WORKSTACK.USED")
  • ENV$("STATUS.STACKS.WORKSTACK.AVAILABLE")
  • ENV$("STATUS.STACKS.WORKSTACK.MAX_USAGE")

Also the command STATUS STACKS shows the current stack settings.

Syntax

Start-up Default

WorkStack 500000 (version 4.3+)

Parameter

"Integer" is a whole number that represents the number of bytes that the work stack may contain. It must be greater than 499 and may be arbitrarily high (e.g. up to 99 million bytes).

Technical Considerations

  1. WorkStack may be specified only in the BRConfig.sys file; it is not valid with the Config command.
  2. The amount of stack memory available depends upon several variables. You may need to monitor your memory usage to determine the optimal stack size for your needs.