$SirParm - Revision history

JAL: misc cleanup

2015-10-06T23:21:38Z

misc cleanup

← Older revision		Revision as of 23:21, 6 October 2015
Line 2:		Line 2:
	<span class="pageSubtitle">Set user-specific value, controlling Sirius products</span>		<span class="pageSubtitle">Set user-specific value, controlling Sirius products</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirParm function.</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirParm function.</p>

	This $function allows setting of parameters that affect the <var class="product">~~User Language~~</var> environment, much like the <var>RESET</var> command.		This $function allows setting of parameters that affect the <var class="product">SOUL</var> environment, much like the <var>RESET</var> command.

	The <var>$SirParm</var> function accepts one to two arguments and returns a numeric result.		The <var>$SirParm</var> function accepts one to two arguments and returns a numeric result.

	~~The first argument is the name of the parameter to be set or whose value is to be returned.~~

	~~The second argument is the new value of the parameter. If this argument is omitted, the value of the parameter is not changed.~~


	==Syntax==		==Syntax==
Line 17:		Line 12:
	</p>		</p>

	<p>		===Syntax terms===
	<~~var class="term"~~>%result</~~var~~> is set to the value of the parameter, which is either <var class="term">new_value</var> or the current parameter value if <var class="term">new_value</var> is not specified.</p>		<table>
			<tr><th>%result</th>
			<td>A numeric variable set to the value of the parameter, which is either <var class="term">new_value</var> or the current parameter value if <var class="term">new_value</var> is not specified.</td></tr>

			<tr><th>parm_name</th>
			<td>The name of the parameter to be set or whose value is to be returned. </td></tr>

			<tr><th>new_value</th>
			<td>The new value of the parameter. If this argument is omitted, the value of the parameter is not changed. </td></tr>
			</table>

	==Usage notes==		==Usage notes==
Line 25:		Line 29:
	<p>		<p>
	There are four types of parameters: </p>		There are four types of parameters: </p>
	<table>		<table class="thJustBold">
	<tr><th>Flags</th>		<tr><th>Flags</th>
	<td>These parameters have value either 0 or 1. Specifying a new value other than 0 results in these parameters being set to 1.</td></tr>		<td>These parameters have value either 0 or 1. Specifying a new value other than 0 results in these parameters being set to 1.</td></tr>
Line 44:		Line 48:
	<tr><th><var>DUMMYSYS</var></th>		<tr><th><var>DUMMYSYS</var></th>
	<td>This is a flag that controls the order of access by dummy string substitution ("?&") to the various scopes (user, subsystem, and system) of global variables. The order corresponding to the 0 and 1 values of DUMMYSYS are:		<td>This is a flag that controls the order of access by dummy string substitution ("?&") to the various scopes (user, subsystem, and system) of global variables. The order corresponding to the 0 and 1 values of DUMMYSYS are:
	<table>		<table class="thJustBold">
	<tr><th>0</th>		<tr><th>0</th>
	<td>first, user globals (those set by $SETG); <br> if not there, subsystem globals (those set by <var>$Setg_Subsys</var>); <br> otherwise, system globals (those set by <var>$Setg_Sys</var>)</td></tr>		<td>first, user globals (those set by $SETG); <br> if not there, subsystem globals (those set by <var>$Setg_Subsys</var>); <br> otherwise, system globals (those set by <var>$Setg_Sys</var>)</td></tr>
Line 62:		Line 66:
	<td>This is a flag that controls the order of access by the $GETG function to the various scopes (user, subsystem, and system) of global variables. The order corresponding to the 0 and 1 values of GETGSYS are:		<td>This is a flag that controls the order of access by the $GETG function to the various scopes (user, subsystem, and system) of global variables. The order corresponding to the 0 and 1 values of GETGSYS are:

	<table>		<table class="thJustBold">
	<tr><th>0</th>		<tr><th>0</th>
	<td>first, user globals (those set by $SETG); <br> if not there, subsystem globals (those set by <var>$Setg_Subsys</var>); <br> otherwise, system globals (those set by <var>$Setg_Sys</var>)</td></tr>		<td>first, user globals (those set by $SETG); <br> if not there, subsystem globals (those set by <var>$Setg_Subsys</var>); <br> otherwise, system globals (those set by <var>$Setg_Sys</var>)</td></tr>

JALWiccan: Automatically generated page update

2015-02-19T23:09:53Z