SetEnv: Difference between revisions
No edit summary |
|||
| Line 1: | Line 1: | ||
The '''SetEnv''' [[internal function]] and [[config]] are used to set session based [[environmental variables]] in [[Business Rules!]]. | The '''SetEnv''' [[internal function]] and [[config]] are used to set [[session]] based [[environmental variables]] in [[Business Rules!]]. | ||
In a [[brconfig.sys]] file you can set a BR environmental variable as follows: | In a [[brconfig.sys]] file you can set a BR environmental variable as follows: | ||
| Line 9: | Line 10: | ||
SetEnv("FIELD","VALUE") | SetEnv("FIELD","VALUE") | ||
The value of either windows environmental variables or BR environmental variable may be accessed in a program | The value of either windows environmental variables or BR environmental variable may be accessed in a [[program]] or [[proc]] by using the [[Env$]] internal function. For example: | ||
Env$("FIELD") | Env$("FIELD") | ||
====Special Variables==== | |||
SetEnv("SCRN_SIZE_POSN") - case insensitive - will save the current screen size and position for both the new console and the command console, provided they are not minimized to the task bar. The positions of any window that is minimized (graphical window or command console) will not be saved. | |||
====GUIMode==== | ====GUIMode==== | ||
| Line 35: | Line 41: | ||
===Clipboard=== | ===Clipboard=== | ||
{{:Clipboard}} | {{:Clipboard}} | ||
<noinclude> | <noinclude> | ||
Revision as of 15:02, 31 January 2014
The SetEnv internal function and config are used to set session based environmental variables in Business Rules!.
In a brconfig.sys file you can set a BR environmental variable as follows:
SetEnv FIELD VALUE
In a program you can set a BR environmental variable as follows:
SetEnv("FIELD","VALUE")
The value of either windows environmental variables or BR environmental variable may be accessed in a program or proc by using the Env$ internal function. For example:
Env$("FIELD")
Special Variables
SetEnv("SCRN_SIZE_POSN") - case insensitive - will save the current screen size and position for both the new console and the command console, provided they are not minimized to the task bar. The positions of any window that is minimized (graphical window or command console) will not be saved.
GUIMode
There is a BR! provided GUIMode environmental variable (case insensitive). It's value is either ON or OFF depending on whether BR is in GUI mode.
x$=env$("GUIMode")
See also:
Icon
The Icon environmental variable can be set during the execution of a program by use of SetEnv.
When the special Icon environmental variable is set it will change the icon which the business rules! application displays.
SetEnv("Icon","myicon.ico") sets the icon for the window and the taskbar to the icon specified by the second parameter (e.g. myicon).
00100 SetEnv('Icon','Myicon.ico')
Environment Variable Simulation
The Env$ function, which is used to interrogate the BR environment, has been expanded to permit the simulation of setting an environment variable with configuration statements. The ENV$ function is case insensitive.
CONFIG SETENV SIZE '10 x 24'
This allows a program to use ENV$("SIZE") to retrieve the value '10 x 24', excluding the quotes. In the event SIZE was previously defined in the environment it will appear as set to the new value for the duration of the BR session.
SetEnv("SCRN_SIZE_POSN") will save the current screen size and position for both the new console and the command console, provided they are not minimized to the task bar. The positions of any window that is minimized (graphical window or command console) will not be saved.
Operating System ENV$ variables cannot be set or altered by CONFIG SETENV.
Clipboard
The SetEnv command and the Env$ internal function enable programmatic access to the windows clipboard.
To set the windows clipboard use:
SETENV("CLIPBOARD" ,"<replacement-value>")
To read the windows clipboard use:
ENV$("CLIPBOARD")
These expressions stow and retrieve data to and from the Windows clipboard. The word 'clipboard' is case insensitive.