Env$ - Revision history

Gordon.dye: /* BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION */

2023-07-09T19:52:25Z

BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION

← Older revision		Revision as of 19:52, 9 July 2023
Line 42:		Line 42:
	The ENV$("STATUS") function can be used to retrieve a broad range of program environment data. It returns the same type of data that the STATUS ENV command returns, except:		The ENV$("STATUS") function can be used to retrieve a broad range of program environment data. It returns the same type of data that the STATUS ENV command returns, except:
	# It populates a string array with the data.		# It populates a string array with the data.
	# ENV$("status" ... returns only the values of environment variables, whereas ST ENV shows each whole ENV$() expression along with its corresponding value.		# '''ENV$("status" ...''' returns only the values of environment variables, whereas '''ST ENV''' shows each whole '''ENV$()''' expression along with its corresponding value.


Line 49:		Line 49:
	ENV$ returns a string, or in the event that a string array (e.g. MAT CONFIG$) is specified, ENV$ redimensions and loads the array with the associated values.		ENV$ returns a string, or in the event that a string array (e.g. MAT CONFIG$) is specified, ENV$ redimensions and loads the array with the associated values.

	Use sub-keywords to restrict the output to exact terms. For a list of valid keywords issue a STATUS ENV -P command.		Use STATUS sub-keywords to restrict the output to exact terms. For a list of valid keywords issue a '''STATUS ENV "status" -P''' command. The subtle aspect of this is that STATUS ENV shows all environment variables accessible via ENV$, whereas only the ENV$("status") values can be sent to an array.

	Note that, while sub-keywords are case insensitive, they must be spelled out in their entirety.		Note that, while sub-keywords are case insensitive, they must be spelled out in their entirety.

Gordon.dye: /* BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION */

2023-07-09T19:28:57Z

BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION

← Older revision		Revision as of 19:28, 9 July 2023
Line 40:		Line 40:
	===BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION===		===BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION===

	The ENV$("STATUS") function can be used to retrieve a broad range of program environment data. It returns the same type of data that the STATUS ENV command returns, except it populates a string array with the data.		The ENV$("STATUS") function can be used to retrieve a broad range of program environment data. It returns the same type of data that the STATUS ENV command returns, except:
			# It populates a string array with the data.
			# ENV$("status" ... returns only the values of environment variables, whereas ST ENV shows each whole ENV$() expression along with its corresponding value.


	ENV$("STATUS [ .sub-keyword ] ... " [, mat config$ ] [, "search-arg , ... " ] )		ENV$("STATUS [ .sub-keyword ] ... " [, mat config$ ] [, "search-arg , ... " ] )

	ENV$ returns a string, or in the event that a string array (e.g. MAT CONFIG$) is specified, ENV$ redimensions and loads the array with the ~~results of a STATUS ENV command~~.		ENV$ returns a string, or in the event that a string array (e.g. MAT CONFIG$) is specified, ENV$ redimensions and loads the array with the associated values.

	Use sub-keywords to restrict the output to exact terms. For a list of valid keywords issue a STATUS ENV -P command.		Use sub-keywords to restrict the output to exact terms. For a list of valid keywords issue a STATUS ENV -P command.

	Note that, while sub-keywords are case insensitive, they must be spelled out in their entirety.		Note that, while sub-keywords are case insensitive, they must be spelled out in their entirety.
	e.g. ENV$('status.attribute') fails to produce any results, whereas ENV$('status.attributes') produces many results.		e.g. '''ENV$('status.attribute')''' fails to produce any results, whereas '''ENV$('status.attributes')''' produces many results.
	[To see a list of attributes currently in effect enter ST ATTR at the keyboard. Or enter ST ENV 'attr' for ENV$ values of specific attributes.] This complete spelling requirement is meant for programs (as distinguished with command line inquiry), and avoids inadvertent argument matching. However, ad-hoc inquiry is facilitated by optional additional case insensitive string filter arguments.		[To see a list of attributes currently in effect enter ST ATTR at the keyboard. Or enter ST ENV 'attr' for ENV$ values of specific attributes.] This complete spelling requirement is meant for programs (as distinguished with command line inquiry), and avoids inadvertent argument matching. However, ad-hoc inquiry is facilitated by optional additional case insensitive string filter arguments.

	Like the [[STATUS ENV]] command, ad hoc comma separated search arguments in a single quoted string may be specified to filter the output. Each search argument provided is matched (case insensitive) against each output line and only matching lines are output. Individual comma separated search words may be preceded with a tilde (~) to indicate exclusion of matching lines. Each argument is space trimmed before comparing.		Like the [[Status#Status Env\|STATUS ENV]] command, ad hoc comma separated search arguments in a single quoted string may be specified to filter the output. Each search argument provided is matched (case insensitive) against each output line and only matching lines are output. Individual comma separated search words may be preceded with a tilde (~) to indicate exclusion of matching lines. Each argument is space trimmed before comparing.

	It is not necessary to provide an array to receive the results. If only one value is needed and no array is provided, the first value produced by the ENV$ call is returned as the string value of the function, and the search argument(s) can conveniently narrow the result to the desired term.		It is not necessary to provide an array to receive the results. If only one value is needed and no array is provided, the first value produced by the ENV$ call is returned as the string value of the function, and the search argument(s) can conveniently narrow the result to the desired term.

Gordon.dye: /* BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION */

2023-07-09T18:56:47Z

BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION

← Older revision		Revision as of 18:56, 9 July 2023
Line 48:		Line 48:
	Use sub-keywords to restrict the output to exact terms. For a list of valid keywords issue a STATUS ENV -P command.		Use sub-keywords to restrict the output to exact terms. For a list of valid keywords issue a STATUS ENV -P command.

	~~Additionally~~, ~~like~~ the [[STATUS ENV]] command, an ad hoc comma separated search arguments in a single quoted string may be specified to filter the output. Each search argument provided is matched (case insensitive) against each output line and only matching lines are output. Individual comma separated search words may be preceded with a tilde (~) to indicate exclusion of matching lines. Each argument is space trimmed before comparing.		Note that, while sub-keywords are case insensitive, they must be spelled out in their entirety.
			e.g. ENV$('status.attribute') fails to produce any results, whereas ENV$('status.attributes') produces many results.
			[To see a list of attributes currently in effect enter ST ATTR at the keyboard. Or enter ST ENV 'attr' for ENV$ values of specific attributes.] This complete spelling requirement is meant for programs (as distinguished with command line inquiry), and avoids inadvertent argument matching. However, ad-hoc inquiry is facilitated by optional additional case insensitive string filter arguments.

			Like the [[STATUS ENV]] command, ad hoc comma separated search arguments in a single quoted string may be specified to filter the output. Each search argument provided is matched (case insensitive) against each output line and only matching lines are output. Individual comma separated search words may be preceded with a tilde (~) to indicate exclusion of matching lines. Each argument is space trimmed before comparing.

	It is not necessary to provide an array to receive the results. If only one value is needed and no array is provided, the first value produced by the ENV$ call is returned as the string value of the function, and the search argument(s) can conveniently narrow the result to the desired term.		It is not necessary to provide an array to receive the results. If only one value is needed and no array is provided, the first value produced by the ENV$ call is returned as the string value of the function, and the search argument(s) can conveniently narrow the result to the desired term.

Gordon.dye: /* Technical Considerations */

2022-04-16T19:50:33Z

Technical Considerations

← Older revision		Revision as of 19:50, 16 April 2022
Line 35:		Line 35:
	# There is a BR provided Env$ variable called GUIMODE (case insensitive). It's value is either ON or OFF depending on whether BR is in [[GUIMode\|GUI mode]].		# There is a BR provided Env$ variable called GUIMODE (case insensitive). It's value is either ON or OFF depending on whether BR is in [[GUIMode\|GUI mode]].
	# The keyword CLIPBOARD retrieves the current contents of the Windows clipboard.		# The keyword CLIPBOARD retrieves the current contents of the Windows clipboard.
	# BR_MODEL returns the model of Business Rules currently operating (COMBINED or CLIENT-SERVER).		# BR_MODEL returns the model of Business Rules currently operating (COMBINED or CLIENT/SERVER).
	# Also see Monitor Interrogation below.		# Also see Monitor Interrogation below.

GomezL: /* Accessing the Client's Environment when in Client Server */

2016-02-11T18:26:06Z

Accessing the Client's Environment when in Client Server

← Older revision		Revision as of 18:26, 11 February 2016
Line 159:		Line 159:
	NOTE: The following code won't work on it's own		NOTE: The following code won't work on it's own

	39032 DIM Cs_Worked$512,Tempenv$2048,Addstr$3, Leftstr$2048, Rightstr$*2048		39032 DIM Cs_Worked$512,Tempenv$2048,Addstr$3, Leftstr$2048, Rightstr$*2048
	39035 LET Cs_Worked$='Failed Execute of: *sys -M set > "'&Cs_Textfile_Make$&'"'		39035 LET Cs_Worked$='Failed Execute of: *sys -M set > "'&Cs_Textfile_Make$&'"'
	39040 EXECUTE '*sys -M set > "'&Cs_Textfile_Make$&'"' ERROR XIT_FNCS_ENV		39040 EXECUTE '*sys -M set > "'&Cs_Textfile_Make$&'"' ERROR XIT_FNCS_ENV
	39045 LET Cs_Worked$='Failed to Open: '&Cs_Textfile_Open$		39045 LET Cs_Worked$='Failed to Open: '&Cs_Textfile_Open$
	39050 OPEN #1: 'NAME='&Cs_Textfile_Open$,DISPLAY,INPUT ERROR XIT_FNCS_ENV		39050 OPEN #1: 'NAME='&Cs_Textfile_Open$,DISPLAY,INPUT ERROR XIT_FNCS_ENV
	39055 LET Cs_Worked$=""		39055 LET Cs_Worked$=""
	39060 STARTLOOP: !		39060 STARTLOOP: !
	39070 LET Addstr$="CS_"		39070 LET Addstr$="CS_"
	39080 DO		39080 DO
	39090 LINPUT #1: Tempenv$ ERROR XIT_LOOP		39090 LINPUT #1: Tempenv$ ERROR XIT_LOOP
	39100 LET Gw_Wholeline=Len(Rtrm$(Tempenv$)) !:		39100 LET Gw_Wholeline=Len(Rtrm$(Tempenv$)) !:
	LET Gw_Addlen=1 !:		LET Gw_Addlen=1 !:
	LET Gw_Posfnwp=Pos(Uprc$(Tempenv$),"=")		LET Gw_Posfnwp=Pos(Uprc$(Tempenv$),"=")
	39110 IF Gw_Posfnwp>0 THEN		39110 IF Gw_Posfnwp>0 THEN
	39120 LET Gw_Equal =Pos(Tempenv$,'=')		39120 LET Gw_Equal =Pos(Tempenv$,'=')
	39130 LET Gw_Nextequal =Pos(Tempenv$,'=',Gw_Posfnwp+Gw_Addlen)		39130 LET Gw_Nextequal =Pos(Tempenv$,'=',Gw_Posfnwp+Gw_Addlen)
	39140 IF Gw_Equal > 0 THEN		39140 IF Gw_Equal > 0 THEN
	39150 LET Leftstr$ = Addstr$&Tempenv$(1:Gw_Posfnwp-1)		39150 LET Leftstr$ = Addstr$&Tempenv$(1:Gw_Posfnwp-1)
	39160 LET Rightstr$ = Tempenv$(Gw_Posfnwp+1:Gw_Wholeline)		39160 LET Rightstr$ = Tempenv$(Gw_Posfnwp+1:Gw_Wholeline)
	39170 LET Setenv(Leftstr$,Rightstr$) ERROR 39180		39170 LET Setenv(Leftstr$,Rightstr$) ERROR 39180
	39180 ! Should SETENV FAIL, Ignore it		39180 ! Should SETENV FAIL, Ignore it
	39190 END IF		39190 END IF
	39200 END IF		39200 END IF
	39210 LOOP		39210 LOOP
	39220 XIT_LOOP: ! End of Startloop		39220 XIT_LOOP: ! End of Startloop
	39230 CLOSE #1: ERROR 39240		39230 CLOSE #1: ERROR 39240
	39240 !		39240 !
	39260 XIT_FNCS_ENV: !		39260 XIT_FNCS_ENV: !

GomezL: /* Monitor Configuration Interrogation */

2016-02-11T18:24:33Z

Monitor Configuration Interrogation

@@ Line 138: / Line 138: @@
 0 1024 768
-<noinclude>
-[[Category: Internal Functions]]
+====Accessing the Client's Environment when in Client Server ====
-</noinclude>

Gordon.dye: /* BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION */

2015-07-18T19:22:23Z

BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION

← Older revision		Revision as of 19:22, 18 July 2015
Line 46:		Line 46:
	ENV$ returns a string, or in the event that a string array (e.g. MAT CONFIG$) is specified, ENV$ redimensions and loads the array with the results of a STATUS ENV command.		ENV$ returns a string, or in the event that a string array (e.g. MAT CONFIG$) is specified, ENV$ redimensions and loads the array with the results of a STATUS ENV command.

	Use sub-keywords to restrict the output to ~~specific values~~. For a list of valid keywords issue a STATUS ENV -P command.		Use sub-keywords to restrict the output to exact terms. For a list of valid keywords issue a STATUS ENV -P command.

	Additionally, like the [[STATUS ENV]] command, an ad hoc ~~space~~ separated search arguments in a single string may be specified to filter the output. Each search argument provided is matched (case insensitive) against each output line and only matching lines are output. Individual ~~space~~ separated search words may be preceded with a tilde (~) to indicate exclusion of matching lines.		Additionally, like the [[STATUS ENV]] command, an ad hoc comma separated search arguments in a single quoted string may be specified to filter the output. Each search argument provided is matched (case insensitive) against each output line and only matching lines are output. Individual comma separated search words may be preceded with a tilde (~) to indicate exclusion of matching lines. Each argument is space trimmed before comparing.

			It is not necessary to provide an array to receive the results. If only one value is needed and no array is provided, the first value produced by the ENV$ call is returned as the string value of the function, and the search argument(s) can conveniently narrow the result to the desired term.

	The following program displays all STATUS information that contains the word “file”:		The following program displays all STATUS information that contains the word “file”:

Gordon.dye: /* BR SETTINGS ENVIRONMENT INTERROGATION */

2015-05-24T02:39:46Z

BR SETTINGS ENVIRONMENT INTERROGATION

← Older revision		Revision as of 02:39, 24 May 2015
Line 38:		Line 38:
	# Also see Monitor Interrogation below.		# Also see Monitor Interrogation below.

	===BR SETTINGS ENVIRONMENT INTERROGATION===		===BR SETTINGS ENVIRONMENT COMPREHENSIVE INTERROGATION===

	The ENV$("STATUS") function can be used to retrieve a broad range of program environment data. It returns the same type of data that the STATUS ENV command returns, except it populates a string array with the data.		The ENV$("STATUS") function can be used to retrieve a broad range of program environment data. It returns the same type of data that the STATUS ENV command returns, except it populates a string array with the data.

	ENV$("STATUS [ .sub-keyword ] ... " [, mat config$ ] [, "search-arg ... " ] )		ENV$("STATUS [ .sub-keyword ] ... " [, mat config$ ] [, "search-arg , ... " ] )

	ENV$ returns a string, or in the event that a string array (e.g. MAT CONFIG$) is specified, ENV$ redimensions and loads the array with the results of a STATUS ENV command.		ENV$ returns a string, or in the event that a string array (e.g. MAT CONFIG$) is specified, ENV$ redimensions and loads the array with the results of a STATUS ENV command.

Gordon.dye: /* Comments and Examples */

2015-05-24T02:37:01Z

Comments and Examples

← Older revision		Revision as of 02:37, 24 May 2015
Line 22:		Line 22:
	00040 if env$("LogName")="root" then chain "Prog14" else goto SHOWMENU		00040 if env$("LogName")="root" then chain "Prog14" else goto SHOWMENU

			For a complete list of possible ENV$ arguments issue the following command:

			[[Status]] Env [ -P ]

			Example:
	ENV$("SERVER_PLATFORM")		ENV$("SERVER_PLATFORM")
	~~returns~~ “WINDOWS”		Returns “WINDOWS”

	====Technical Considerations====		====Technical Considerations====

Gordon.dye: /* Comments and Examples */

2015-05-24T02:33:03Z

Comments and Examples

← Older revision		Revision as of 02:33, 24 May 2015
Line 21:		Line 21:

	00040 if env$("LogName")="root" then chain "Prog14" else goto SHOWMENU		00040 if env$("LogName")="root" then chain "Prog14" else goto SHOWMENU


	ENV$("SERVER_PLATFORM")		ENV$("SERVER_PLATFORM")