RETRVOPT parameter - Revision history

DCameron: /* Description */

2017-05-24T09:31:36Z

Description

← Older revision		Revision as of 09:31, 24 May 2017
Line 49:		Line 49:

	A command you enter when on the		A command you enter when on the
	penultimate page of a multi-page output (like from a <var>VIEW</var> command) that		penultimate page of a multi-page output (like from a <var>[[VIEW_command\|VIEW]]</var> command) that
	gets processed after the next page of data is '''not''' saved in the retrieve buffer.		gets processed after the next page of data is '''not''' saved in the retrieve buffer.

DmeWiccan: Automatically generated page update

2013-08-27T16:43:19Z

Automatically generated page update

← Older revision		Revision as of 16:43, 27 August 2013
Line 1:		Line 1:
			{{Template:RETRVOPT parameter subtitle}}
	==Summary==		==Summary==
	<dl>		<dl>

JALWiccan: Automatically generated page update

2013-04-19T20:07:02Z

Automatically generated page update

← Older revision		Revision as of 20:07, 19 April 2013
Line 10:		Line 10:
	<dd>All		<dd>All
	<dt>Introduced		<dt>Introduced
	<dd><var class="product">Sirius Mods</var> 7.3		<dd><var class="product">[[Sirius Mods]]</var> 7.3
	</dl>		</dl>
	==Description==		==Description==

JAL: /* Description */

2013-04-08T14:43:27Z

Description

← Older revision		Revision as of 14:43, 8 April 2013
Line 20:		Line 20:
	<dl>		<dl>
	<dt>X'01'		<dt>X'01'
	<dd>The PF key that is 1 higher than the <var>RETRVKEY</var> setting is mapped		<dd>The PF key that is 1 higher than the <var>[[RETRVKEY parameter\|RETRVKEY]]</var> setting is mapped
	to a forward retrieval operation, which		to a forward retrieval operation, which
	returns the command in the retrieve buffer that follows the one that is currently displayed.		returns the command in the retrieve buffer that follows the one that is currently displayed.

JAL2: /* Description */

2012-03-13T20:36:03Z

Description

← Older revision		Revision as of 20:36, 13 March 2012
Line 14:		Line 14:
	==Description==		==Description==
	This is a bitmask parameter that controls some characteristics of the		This is a bitmask parameter that controls some characteristics of the
	[[Model 204]] retrieve key,		<var class="product">Model 204</var> retrieve key,
	the 3270 terminal PF key that retrieves previously input command lines.		the 3270 terminal PF key that retrieves previously input command lines.

	The meaning of the RETRVOPT bits are:		The meaning of the <var>RETRVOPT</var> bits are:
	<dl>		<dl>
	<dt>X'01'		<dt>X'01'
	<dd>The PF key that is 1 higher than the RETRVKEY setting is mapped		<dd>The PF key that is 1 higher than the <var>RETRVKEY</var> setting is mapped
	to a forward retrieval operation, which		to a forward retrieval operation, which
	returns the command in the retrieve buffer that follows the one that is currently		returns the command in the retrieve buffer that follows the one that is currently displayed.
	displayed.		For example, if this X'01' bit is set, and <var>RETRVKEY</var> is set to 6,
	For example, if this X'01' bit is set, and RETRVKEY is set to 6,
	PF7 will be a forward retrieve key.		PF7 will be a forward retrieve key.

	If the RETRVKEY setting is 24, specifying this X'01' bit maps the forward		If the <var>RETRVKEY</var> setting is 24, specifying this X'01' bit maps the forward
	operation to the PF1 key.		operation to the PF1 key.
	<dt>X'02'		<dt>X'02'
	<dd>The forward and backward retrieve keys will '''not''' wrap.		<dd>The forward and backward retrieve keys will '''not''' wrap.
	With this bit set,		With this bit set, if you retrieve all the commands stored in the retrieve buffer,
	if you retrieve all the commands stored in the retrieve buffer,
	your next retrieval is a blank (instead of wrapping to the beginning of the		your next retrieval is a blank (instead of wrapping to the beginning of the
	retrieval ring, as was the behavior prior to the availability of the RETRVOPT		retrieval ring, as was the behavior prior to the availability of the <var>RETRVOPT</var> parameter).
	parameter).

	The retrieve buffer is a virtual storage area allocated for any full screen		The retrieve buffer is a virtual storage area allocated for any full screen
	thread that has a retrieve key set, and its size is controlled by the		thread that has a retrieve key set, and its size is controlled by the <var>[[RETRVBUF parameter\|RETRVBUF]]</var>.
	[[RETRVBUF parameter]].

	It is recommended that you set RETRVOPT X'02' in tandem with RETRVOPT X'01'.		It is recommended that you set <code>RETRVOPT X'02'</code> in tandem with <code>RETRVOPT X'01'</code>.
	Otherwise, once you reach the end of the retrieve buffer, you will be unable to		Otherwise, once you reach the end of the retrieve buffer, you will be unable to
	get at the retrieved data until you press the Enter key or some other PF key.		get at the retrieved data until you press the Enter key or some other PF key.
	<dt>X'04'		<dt>X'04'
	<dd>Do not add to the retrieve buffer any text typed in response to a screen-full		<dd>Do not add to the retrieve buffer any text typed in response to a screen-full prompt.
	prompt.
	For example,		For example,
	if you issue a ~~''''~~VIEW~~''''~~, then type ~~''''~~C~~''''~~ or ~~''''~~K~~''''~~ to		if you issue a <code>VIEW</code>, then type <code>C</code> or <code>K</code> to
	stop the output, the ~~''''~~C~~''''~~ or ~~''''~~K~~''''~~		stop the output, the <code>C</code> or <code>K</code>
	is added to the retrieve buffer — unless RETRVOPT X'04' is set.		is added to the retrieve buffer — unless <code>RETRVOPT X'04'</code> is set.

	A command you enter when on the		A command you enter when on the
	penultimate page of a multi-page output (like from a VIEW command) that		penultimate page of a multi-page output (like from a <var>VIEW</var> command) that
	gets processed after the next page of data is '''not'''		gets processed after the next page of data is '''not''' saved in the retrieve buffer.
	saved in the retrieve buffer.

	RETRVOPT X'04' also prevents ~~''''~~N~~''''~~, ~~''''~~NP~~''''~~,		<code>RETRVOPT X'04'</code> also prevents <var>N</var>, <var>NP</var>, or <var>NEW</var> commands
	or ~~''''~~NEW~~''''~~ commands
	(which clear the screen) from being added to the retrieve buffer.		(which clear the screen) from being added to the retrieve buffer.
	<dt>X'10'		<dt>X'10'
	<dd>If the X'01' bit is also set, RETRVOPT X'10' maps the		<dd>If the X'01' bit is also set, <code>RETRVOPT X'10'</code> maps the
	forward retrieve key to the PF key that is 12 greater than the current		forward retrieve key to the PF key that is 12 greater than the current
	retrieve key (setting of RETRVKEY).		retrieve key (setting of <var>RETRVKEY</var>).
	This will be the shifted version of the current retrieve key if that current		This will be the shifted version of the current retrieve key if that current
	key is less than PF13, and it will be the non-shifted version if that key is		key is less than PF13, and it will be the non-shifted version if that key is greater than PF12.
	greater than PF12.

	For example, if RETRVOPT is set to X'17' and RETRVKEY is 12,		For example, if <var>RETRVOPT</var> is set to X'17' and <var>RETRVKEY</var> is 12,
	the forward retrieve key is PF24.		the forward retrieve key is PF24.
	And if RETRVOPT is set to X'17' and		And if <var>RETRVOPT</var> is set to X'17' and
	RETRVKEY is 21 (Shift+PF9), the forward retrieve key is PF9.		<var>RETRVKEY</var> is 21 (Shift+PF9), the forward retrieve key is PF9.
	</dl>		</dl>

	[[Category:User parameters]]		[[Category:User parameters]]
	[[Category:Parameters]]		[[Category:Parameters]]

JALWiccan: 1 revision

2012-03-13T18:42:17Z

1 revision

New page

==Summary==
<dl>
<dt>Default value
<dd>X'00'
<dt>Parameter type
<dd>User
<dt>Where set
<dd>User resettable
<dt>Related products
<dd>All
<dt>Introduced
<dd><var class="product">Sirius Mods</var> 7.3
</dl>
==Description==
This is a bitmask parameter that controls some characteristics of the
[[Model 204]] retrieve key,
the 3270 terminal PF key that retrieves previously input command lines.

The meaning of the RETRVOPT bits are:
<dl>
<dt>X'01'
<dd>The PF key that is 1 higher than the RETRVKEY setting is mapped
to a forward retrieval operation, which
returns the command in the retrieve buffer that follows the one that is currently
displayed.
For example, if this X'01' bit is set, and RETRVKEY is set to 6,
PF7 will be a forward retrieve key.

If the RETRVKEY setting is 24, specifying this X'01' bit maps the forward
operation to the PF1 key.
<dt>X'02'
<dd>The forward and backward retrieve keys will '''not''' wrap.
With this bit set,
if you retrieve all the commands stored in the retrieve buffer,
your next retrieval is a blank (instead of wrapping to the beginning of the
retrieval ring, as was the behavior prior to the availability of the RETRVOPT
parameter).

The retrieve buffer is a virtual storage area allocated for any full screen
thread that has a retrieve key set, and its size is controlled by the
[[RETRVBUF parameter]].

It is recommended that you set RETRVOPT X'02' in tandem with RETRVOPT X'01'.
Otherwise, once you reach the end of the retrieve buffer, you will be unable to
get at the retrieved data until you press the Enter key or some other PF key.
<dt>X'04'
<dd>Do not add to the retrieve buffer any text typed in response to a screen-full
prompt.
For example,
if you issue a ''''VIEW'''', then type ''''C'''' or ''''K'''' to
stop the output, the ''''C'''' or ''''K''''
is added to the retrieve buffer — unless RETRVOPT X'04' is set.

A command you enter when on the
penultimate page of a multi-page output (like from a VIEW command) that
gets processed after the next page of data is '''not'''
saved in the retrieve buffer.

RETRVOPT X'04' also prevents ''''N'''', ''''NP'''',
or ''''NEW'''' commands
(which clear the screen) from being added to the retrieve buffer.
<dt>X'10'
<dd>If the X'01' bit is also set, RETRVOPT X'10' maps the
forward retrieve key to the PF key that is 12 greater than the current
retrieve key (setting of RETRVKEY).
This will be the shifted version of the current retrieve key if that current
key is less than PF13, and it will be the non-shifted version if that key is
greater than PF12.

For example, if RETRVOPT is set to X'17' and RETRVKEY is 12,
the forward retrieve key is PF24.
And if RETRVOPT is set to X'17' and
RETRVKEY is 21 (Shift+PF9), the forward retrieve key is PF9.
</dl>

[[Category:User parameters]]
[[Category:Parameters]]