$ResetN - Revision history

Dme at 00:16, 11 November 2019

2019-11-11T00:16:14Z

← Older revision		Revision as of 00:16, 11 November 2019
Line 1:		Line 1:
	{{DISPLAYTITLE:$~~Resetn~~}}		{{DISPLAYTITLE:$ResetN}}
	<span class="pageSubtitle">Reset or view M204 parameter</span>		<span class="pageSubtitle">Reset or view M204 parameter</span>

	<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$~~Resetn~~</var> 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 <var>$ResetN</var> function.</p>

	This [[Calling Sirius Mods $functions\|callable]] function retrieves the current value of a <var class="product">Model 204</var> parameter, and it can also change the value of that parameter. Not all parameters are resettable by $~~Resetn~~: the supported subset includes only parameters considered useful to change as well as safe to change during evaluation of a <var class="product">SOUL</var> request.		This [[Calling Sirius Mods $functions\|callable]] function retrieves the current value of a <var class="product">Model 204</var> parameter, and it can also change the value of that parameter. Not all parameters are resettable by $ResetN: the supported subset includes only parameters considered useful to change as well as safe to change during evaluation of a <var class="product">SOUL</var> request.

	<var>$~~Resetn~~</var> accepts one required and two optional arguments, and it returns a numeric value.		<var>$ResetN</var> accepts one required and two optional arguments, and it returns a numeric value.

	==Syntax==		==Syntax==
	<p class="syntax">[%oldval =] $~~Resetn~~(parameter, newval, %rc_variable)		<p class="syntax">[%oldval =] $ResetN(parameter, newval, %rc_variable)
	</p>		</p>

Line 15:		Line 15:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%oldval</th>		<tr><th>%oldval</th>
	<td>The returned value is the current value of <var class="term">parameter</var> (before <var>$~~Resetn~~</var> changes it). If the <var class="term">parameter</var> is not the name of a parameter supported by <var>$~~Resetn~~</var>, the returned value is 0 (if <var class="term">%rc_variable</var> is supplied; otherwise this and all errors cause request cancellation).</td></tr>		<td>The returned value is the current value of <var class="term">parameter</var> (before <var>$ResetN</var> changes it). If the <var class="term">parameter</var> is not the name of a parameter supported by <var>$ResetN</var>, the returned value is 0 (if <var class="term">%rc_variable</var> is supplied; otherwise this and all errors cause request cancellation).</td></tr>

	<tr><th>parameter</th>		<tr><th>parameter</th>
	<td>A string that is the name of the parameter to retrieve (and optionally reset). See the list of allowed parameters in [[#Parameters resettable by $~~Resetn~~\|Parameters resettable by $~~Resetn~~]]. </td></tr>		<td>A string that is the name of the parameter to retrieve (and optionally reset). See the list of allowed parameters in [[#Parameters resettable by $ResetN\|Parameters resettable by $ResetN]]. </td></tr>

	<tr><th>newval</th>		<tr><th>newval</th>
Line 24:		Line 24:

	<tr><th>%rc_variable</th>		<tr><th>%rc_variable</th>
	<td>An optional %variable that is the target for the <var>$~~Resetn~~</var> return code. If specified, this %variable is set to one of the return codes shown [[#Return codes\|below]]. If this argument is omitted and a condition occurs that is associated with a non-zero return code value, the request is cancelled.		<td>An optional %variable that is the target for the <var>$ResetN</var> return code. If specified, this %variable is set to one of the return codes shown [[#Return codes\|below]]. If this argument is omitted and a condition occurs that is associated with a non-zero return code value, the request is cancelled.
	<p>		<p>
	This %variable may '''not''' be a <var class="product">SOUL</var> [[Classes_and_Objects#Variable_declarations\|class variable]]. </p></td></tr>		This %variable may '''not''' be a <var class="product">SOUL</var> [[Classes_and_Objects#Variable_declarations\|class variable]]. </p></td></tr>
Line 38:		Line 38:
	For example, the following fragment will to prevent the <code>M204.0620 FILE OPENED</code> and <code>M204.1203 FILE WAS LAST UPDATED</code> messages from going to the user's terminal:		For example, the following fragment will to prevent the <code>M204.0620 FILE OPENED</code> and <code>M204.1203 FILE WAS LAST UPDATED</code> messages from going to the user's terminal:

	<p class="code">%VAL = $~~Resetn~~('MSGCTL', 2)		<p class="code">%VAL = $ResetN('MSGCTL', 2)
	OPEN 'MYFILE' PASSWORD 'UPDATE'		OPEN 'MYFILE' PASSWORD 'UPDATE'
	%VAL = $~~Resetn~~('MSGCTL', %VAL)		%VAL = $ResetN('MSGCTL', %VAL)
	</p>		</p>

	==Parameters resettable by $~~Resetn~~==		==Parameters resettable by $ResetN==
	In the following list of parameters, the minimum and maximum value is shown. Note that these values may be more strict than the corresponding minimums and maximums allowed by the <var class="product">Model 204</var> <var>[[RESET command\|RESET]]</var> command. For example, the <code>RESET ERMX -2</code> command changes <var>[[ERMX parameter\|ERMX]]</var> to a value, as shown by the response to the command, of 65534. However, the value of -2 is not "meaningful" for <var>ERMX</var>. To avoid this, an attempt to invoke <code>$~~Resetn~~('ERMX',-2)</code> is rejected, because -2 is outside the legal range for <var>ERMX</var>.		In the following list of parameters, the minimum and maximum value is shown. Note that these values may be more strict than the corresponding minimums and maximums allowed by the <var class="product">Model 204</var> <var>[[RESET command\|RESET]]</var> command. For example, the <code>RESET ERMX -2</code> command changes <var>[[ERMX parameter\|ERMX]]</var> to a value, as shown by the response to the command, of 65534. However, the value of -2 is not "meaningful" for <var>ERMX</var>. To avoid this, an attempt to invoke <code>$ResetN('ERMX',-2)</code> is rejected, because -2 is outside the legal range for <var>ERMX</var>.

	<p class="note">'''Note: ''' This situation is even more pointed for <var>UDDLPP</var>, which is currently not supported for <var>$~~Resetn~~</var> because there is little reason to change it from within a <var class="product">SOUL</var> request.</p>		<p class="note">'''Note: ''' This situation is even more pointed for <var>UDDLPP</var>, which is currently not supported for <var>$ResetN
			</var> because there is little reason to change it from within a <var class="product">SOUL</var> request.</p>

	The <code>RESET UDDLPP -1</code> command changes <var>[[UDDLPP parameter\|UDDLPP]]</var> to a value of 65535, as shown by the response to the command or as returned by <var>$VIEW</var>. However, the <code>RESET UDDLPP 65535</code> command issues an error message and changes <var>UDDLPP</var> to the value of 32767, which is very different from the meaning of -1 for <var>UDDLPP</var>.		The <code>RESET UDDLPP -1</code> command changes <var>[[UDDLPP parameter\|UDDLPP]]</var> to a value of 65535, as shown by the response to the command or as returned by <var>$VIEW</var>. However, the <code>RESET UDDLPP 65535</code> command issues an error message and changes <var>UDDLPP</var> to the value of 32767, which is very different from the meaning of -1 for <var>UDDLPP</var>.

	The valid parameter names which may be supplied as the <var class="term">parameter</var> argument to <var>$~~Resetn~~</var> are shown in the following list, along with the minimum and maximum values and a terse description.		The valid parameter names which may be supplied as the <var class="term">parameter</var> argument to <var>$ResetN</var> are shown in the following list, along with the minimum and maximum values and a terse description.
	<table>		<table>
	<tr><th><var>[[ENQRETRY parameter\|ENQRETRY]]</var></th>		<tr><th><var>[[ENQRETRY parameter\|ENQRETRY]]</var></th>
Line 95:		Line 96:
	</td></tr></table>		</td></tr></table>

	Some of the parameters supported by <var>$~~Resetn~~</var> are treated as "hexadecimal" parameters by the <var class="product">Model 204</var> <var>RESET</var> command. For example, the <code>VIEW HDRCTL</code> command displays a result such as <code>X'01'</code>. It so happens that this is a moot point with any of these "hex" parameters currently supported by <var>$~~Resetn~~</var>, because the maximum value they may have is 7, which is the same in base 10 and base 16.		Some of the parameters supported by <var>$ResetN</var> are treated as "hexadecimal" parameters by the <var class="product">Model 204</var> <var>RESET</var> command. For example, the <code>VIEW HDRCTL</code> command displays a result such as <code>X'01'</code>. It so happens that this is a moot point with any of these "hex" parameters currently supported by <var>$ResetN</var>, because the maximum value they may have is 7, which is the same in base 10 and base 16.
	<p>		<p>
	However, if <var>$~~Resetn~~</var> is extended to support, for example, <var>UDDRFM</var>, you might wish to supply an argument to <var>$~~Resetn~~</var> expressed in hex. This could be easily accomplished using the <var>$X2D</var> function. Again, assuming <var>$~~Resetn~~</var> were extended to support <var>UDDRFM</var>, you could set the USE dataset record format to variable length records with ASA carriage control with the following statement:</p>		However, if <var>$ResetN</var> is extended to support, for example, <var>UDDRFM</var>, you might wish to supply an argument to <var>$ResetN</var> expressed in hex. This could be easily accomplished using the <var>$X2D</var> function. Again, assuming <var>$ResetN</var> were extended to support <var>UDDRFM</var>, you could set the USE dataset record format to variable length records with ASA carriage control with the following statement:</p>

	<p class="code">%VAL = $~~Resetn~~('UDDRFM', $X2D('12'))		<p class="code">%VAL = $ResetN('UDDRFM', $X2D('12'))
	</p>		</p>

Line 120:		Line 121:


	[[Category:$Functions\|$~~Resetn~~]]		[[Category:$Functions\|$ResetN]]

Dme: Dme moved page $Resetn to $ResetN

2019-11-11T00:00:26Z

Dme moved page $Resetn to $ResetN

← Older revision	Revision as of 00:00, 11 November 2019
(No difference)

JAL: /* Parameters resettable by $Resetn */ add `s`

2018-04-18T16:43:08Z

Parameters resettable by $Resetn: add <var>s

← Older revision		Revision as of 16:43, 18 April 2018
Line 44:		Line 44:

	==Parameters resettable by $Resetn==		==Parameters resettable by $Resetn==
	In the following list of parameters, the minimum and maximum value is shown. Note that these values may be more strict than the corresponding minimums and maximums allowed by the <var class="product">Model 204</var> <var>[[RESET command\|RESET]]</var> command. For example, the <code>RESET ERMX -2</code> command changes <var>[[ERMX parameter\|ERMX]]</var> to a value, as shown by the response to the command, of 65534. However, the value of -2 is not "meaningful" for <var>ERMX</var>. To avoid this, an attempt to invoke <code>$Resetn('ERMX',-2)</code> is rejected, because -2 is outside the legal range for <var>ERMX</var>.		In the following list of parameters, the minimum and maximum value is shown. Note that these values may be more strict than the corresponding minimums and maximums allowed by the <var class="product">Model 204</var> <var>[[RESET command\|RESET]]</var> command. For example, the <code>RESET ERMX -2</code> command changes <var>[[ERMX parameter\|ERMX]]</var> to a value, as shown by the response to the command, of 65534. However, the value of -2 is not "meaningful" for <var>ERMX</var>. To avoid this, an attempt to invoke <code>$Resetn('ERMX',-2)</code> is rejected, because -2 is outside the legal range for <var>ERMX</var>.

	<p class="note">'''Note: ''' This situation is even more pointed for <var>UDDLPP</var>, which is currently not supported for <var>$Resetn</var> because there is little reason to change it from within a <var class="product">SOUL</var> request.</p>		<p class="note">'''Note: ''' This situation is even more pointed for <var>UDDLPP</var>, which is currently not supported for <var>$Resetn</var> because there is little reason to change it from within a <var class="product">SOUL</var> request.</p>
Line 95:		Line 95:
	</td></tr></table>		</td></tr></table>

	Some of the parameters supported by <var>$Resetn</var> are treated as "hexadecimal" parameters by the <var class="product">Model 204</var> <var>RESET</var> command. For example, the <code>VIEW HDRCTL</code> command displays a result such as <code>X'01'</code>. It so happens that this is a moot point with any of these "hex" parameters currently supported by <var>$Resetn</var>, because the maximum value they may have is 7, which is the same in base 10 and base 16.		Some of the parameters supported by <var>$Resetn</var> are treated as "hexadecimal" parameters by the <var class="product">Model 204</var> <var>RESET</var> command. For example, the <code>VIEW HDRCTL</code> command displays a result such as <code>X'01'</code>. It so happens that this is a moot point with any of these "hex" parameters currently supported by <var>$Resetn</var>, because the maximum value they may have is 7, which is the same in base 10 and base 16.
	<p>		<p>
	However, if <var>$Resetn</var> is extended to support, for example, UDDRFM, you might wish to supply an argument to <var>$Resetn</var> expressed in hex. This could be easily accomplished using the <var>$X2D</var> function. Again, assuming <var>$Resetn</var> were extended to support <var>UDDRFM</var>, you could set the USE dataset record format to variable length records with ASA carriage control with the following statement:</p>		However, if <var>$Resetn</var> is extended to support, for example, <var>UDDRFM</var>, you might wish to supply an argument to <var>$Resetn</var> expressed in hex. This could be easily accomplished using the <var>$X2D</var> function. Again, assuming <var>$Resetn</var> were extended to support <var>UDDRFM</var>, you could set the USE dataset record format to variable length records with ASA carriage control with the following statement:</p>

	<p class="code">%VAL = $Resetn('UDDRFM', $X2D('12'))		<p class="code">%VAL = $Resetn('UDDRFM', $X2D('12'))

JAL: misc formatting

2018-04-18T16:41:07Z

misc formatting

Dme: /* Parameters resettable by $Resetn */

2018-04-18T15:18:48Z

Parameters resettable by $Resetn

← Older revision		Revision as of 15:18, 18 April 2018
Line 53:		Line 53:
	<table>		<table>
	<tr><th><var>[[ENQRETRY parameter\|ENQRETRY]]</var></th>		<tr><th><var>[[ENQRETRY parameter\|ENQRETRY]]</var></th>
	<td>0..255: ~~Number of record~~ locking ~~retries~~</td></tr>		<td>0..255: Record locking retry count</td></tr>
			<tr><th><var>[[ENQTIME parameter\|ENQTIME]]</var></th>
			<td>1..60000: Record locking retry wait time, milliseconds (new in version 7.8 or 7.7 with zap 77Z299)</td></tr>
	<tr><th><var>[[ERCNT parameter\|ERCNT]]</var></th>		<tr><th><var>[[ERCNT parameter\|ERCNT]]</var></th>
	<td>0..65,535: Error count (provided by the <var class="product">Sirius Mods</var>). (Note that the you can also increment or clear this using [[$ErrSet]].)</td></tr>		<td>0..65,535: Error count (provided by the <var class="product">Sirius Mods</var>). (Note that the you can also increment or clear this using [[$ErrSet]].)</td></tr>

JALWiccan: Automatically generated page update

2015-02-19T23:09:44Z