$EcbDSet - Revision history

JAL: minor formatting

2018-01-02T17:18:14Z

minor formatting

← Older revision		Revision as of 17:18, 2 January 2018
Line 2:		Line 2:

	==Syntax==		==Syntax==
	<p class="~~code~~">$EcbDSet({ECB-number \| 'CPQZ'},{'string'})		<p class="syntax">$EcbDSet({<span class="term">ECB-number</span> \| 'CPQZ'},{'<span class="term">string</span>'})
	</p>		</p>
	<p>		<p>
	Where:</p>		Where:</p>
	<ul>		<ul>
	<li>ECB-number is a numeric value (which may range from one to the value of the <var>[[NECBS parameter\|NECBS]]</var> parameter) that identifies the ECB in which to store the string of data.</li>		<li><var class="term">ECB-number</var> is a numeric value (which may range from one to the value of the <var>[[NECBS parameter\|NECBS]]</var> parameter) that identifies the ECB in which to store the string of data.</li>

	<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See [[System and media recovery#Media recovery NonStop/204\|Media recovery NonStop/204]] for an explanation of the facility.		<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See [[System and media recovery#Media recovery NonStop/204\|Media recovery NonStop/204]] for an explanation of the facility.
Line 14:		Line 14:
	</li>		</li>

	<li>string can be up to 255 bytes long.</li>		<li><var class="term">string</var> can be up to 255 bytes long.</li>
	<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the <var>$Post</var> or <var>$EcbDSet</var> functions.</p></li>		<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the <var>$Post</var> or <var>$EcbDSet</var> functions.</p></li>
	</ul>		</ul>

Dme: /* Example */

2017-12-27T12:37:52Z

Example

← Older revision		Revision as of 12:37, 27 December 2017
Line 84:		Line 84:

	==Example==		==Example==
	<p class="code">%x=$~~Ecbdset~~(1,'This is about managing user threads')		<p class="code">%x=$ecbdSet(1,'This is about managing user threads')
	</p>		</p>

			==See also==
			The ECB-related $functions are:
			<ul>
			<li><var>[[$EcbDGet]]</var>
			<li><var>[[$EcbDSet]]</var>
			<li><var>[[$EcbTest\|$EcbTest]]</var>
			<li><var>[[$Post]]</var>
			<li><var>[[$UnPost]]</var>
			<li><var>[[$Wait]]</var>
			</ul>

	[[Category:SOUL $functions]]		[[Category:SOUL $functions]]

Dme: /* Syntax */

2017-12-27T12:32:32Z

Syntax

← Older revision		Revision as of 12:32, 27 December 2017
Line 14:		Line 14:
	</li>		</li>

	<li>string can be up to 255 bytes long~~. It can be a numeric, a literal, a %variable, or a field name~~.</li>		<li>string can be up to 255 bytes long.</li>
	<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the <var>$Post</var> or <var>$EcbDSet</var> functions.</p></li>		<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the <var>$Post</var> or <var>$EcbDSet</var> functions.</p></li>
	</ul>		</ul>

Dme: /* Syntax */

2017-12-27T12:31:25Z

Syntax

← Older revision		Revision as of 12:31, 27 December 2017
Line 7:		Line 7:
	Where:</p>		Where:</p>
	<ul>		<ul>
	<li>ECB-number is ~~a string with~~ a numeric value from one to the NECBS parameter that identifies the ECB in which to store the string of data~~. The ECB-number can be expressed as a numeric literal, a %variable, or a field name~~.</li>		<li>ECB-number is a numeric value (which may range from one to the value of the <var>[[NECBS parameter\|NECBS]]</var> parameter) that identifies the ECB in which to store the string of data.</li>

	<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See [[System and media recovery#Media recovery NonStop/204\|Media recovery NonStop/204]] for an explanation of the facility.		<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See [[System and media recovery#Media recovery NonStop/204\|Media recovery NonStop/204]] for an explanation of the facility.

Admin: Admin moved page $EcbDset to $EcbDSet without leaving a redirect: typo in name

2014-09-08T20:18:03Z

Admin moved page $EcbDset to $EcbDSet without leaving a redirect: typo in name

← Older revision	Revision as of 20:18, 8 September 2014
(No difference)

JALWiccan: Automatically generated page update

2014-09-08T20:14:48Z

Automatically generated page update

← Older revision		Revision as of 20:14, 8 September 2014
Line 81:		Line 81:
	</tr>		</tr>
	</table>		</table>
	<p class="note"><b>Note:</b> The <var>$EcbDSet</var> function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by <var>$EcbDSet</var> is accessible using the <var>[[$~~EcbDget~~]]</var> function.</p>		<p class="note"><b>Note:</b> The <var>$EcbDSet</var> function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by <var>$EcbDSet</var> is accessible using the <var>[[$EcbDGet]]</var> function.</p>

	==Example==		==Example==

JALWiccan: Automatically generated page update

2014-09-08T20:13:00Z

Automatically generated page update

← Older revision		Revision as of 20:13, 8 September 2014
Line 1:		Line 1:
	<var>$~~EcbDset~~</var> sets string data associated with an Event Control Block (ECB).		<var>$EcbDSet</var> sets string data associated with an Event Control Block (ECB).

	==Syntax==		==Syntax==
	<p class="code">$~~EcbDset~~({ECB-number \| 'CPQZ'},{'string'})		<p class="code">$EcbDSet({ECB-number \| 'CPQZ'},{'string'})
	</p>		</p>
	<p>		<p>
Line 11:		Line 11:
	<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See [[System and media recovery#Media recovery NonStop/204\|Media recovery NonStop/204]] for an explanation of the facility.		<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See [[System and media recovery#Media recovery NonStop/204\|Media recovery NonStop/204]] for an explanation of the facility.
	<p>		<p>
	To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. When CPQZ is specified, the value of the <var>$~~EcbDset~~</var> function can be non-null (except for error values) during only extended quiesce. CPQZ is internally cleared to null when the system exits extended quiesce.</p>		To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. When CPQZ is specified, the value of the <var>$EcbDSet</var> function can be non-null (except for error values) during only extended quiesce. CPQZ is internally cleared to null when the system exits extended quiesce.</p>
	</li>		</li>

	<li>string can be up to 255 bytes long. It can be a numeric, a literal, a %variable, or a field name.</li>		<li>string can be up to 255 bytes long. It can be a numeric, a literal, a %variable, or a field name.</li>
	<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the <var>$Post</var> or <var>$~~EcbDset~~</var> functions.</p></li>		<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the <var>$Post</var> or <var>$EcbDSet</var> functions.</p></li>
	</ul>		</ul>

	==Usage==		==Usage==
	<p>The <var>$~~EcbDset~~</var> function returns the following return codes:</p>		<p>The <var>$EcbDSet</var> function returns the following return codes:</p>
	<table>		<table>
	<tr class="head">		<tr class="head">
Line 53:		Line 53:
	<tr>		<tr>
	<td align="right">7 </td>		<td align="right">7 </td>
	<td><var>$~~EcbDset~~</var> missing data argument</td>		<td><var>$EcbDSet</var> missing data argument</td>
	</tr>		</tr>

Line 81:		Line 81:
	</tr>		</tr>
	</table>		</table>
	<p class="note"><b>Note:</b> The <var>$~~EcbDset~~</var> function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by <var>$~~EcbDset~~</var> is accessible using the <var>[[$EcbDget]]</var> function.</p>		<p class="note"><b>Note:</b> The <var>$EcbDSet</var> function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by <var>$EcbDSet</var> is accessible using the <var>[[$EcbDget]]</var> function.</p>

	==Example==		==Example==

JAL at 19:36, 8 September 2014

2014-09-08T19:36:21Z

← Older revision		Revision as of 19:36, 8 September 2014
Line 1:		Line 1:
	<b>~~Function~~</b>		<var>$EcbDset</var> sets string data associated with an Event Control Block (ECB).
	<p>~~Set~~ string data associated with an Event Control Block (ECB)~~</p>~~
	~~<b>~~Syntax~~</b>~~		==Syntax==
	<p class="code">$~~ECBDSET~~({ECB-number \| 'CPQZ'},{'string'})		<p class="code">$EcbDset({ECB-number \| 'CPQZ'},{'string'})
	</p>		</p>
	<p>Where:</p>		<p>
			Where:</p>
	<ul>		<ul>
	<li>ECB-number is a string with a numeric value from one to the NECBS parameter that identifies the ECB in which to store the string of data. The ECB-number can be expressed as a numeric literal, a %variable, or a field name.</li>		<li>ECB-number is a string with a numeric value from one to the NECBS parameter that identifies the ECB in which to store the string of data. The ECB-number can be expressed as a numeric literal, a %variable, or a field name.</li>

			<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See [[System and media recovery#Media recovery NonStop/204\|Media recovery NonStop/204]] for an explanation of the facility.
			<p>
			To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. When CPQZ is specified, the value of the <var>$EcbDset</var> function can be non-null (except for error values) during only extended quiesce. CPQZ is internally cleared to null when the system exits extended quiesce.</p>
	</li>		</li>
	<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility.</li>
	<p>To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. When CPQZ is specified, the value of the $ECBDSET function can be non-null (except for error values) during only extended quiesce. CPQZ is internally cleared to null when the system exits extended quiesce.</p>
	~~</li>~~
	<li>string can be up to 255 bytes long. It can be a numeric, a literal, a %variable, or a field name.</li>		<li>string can be up to 255 bytes long. It can be a numeric, a literal, a %variable, or a field name.</li>
	<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the $~~POST~~ or $~~ECBDSET~~ functions.</p>		<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the <var>$Post</var> or <var>$EcbDset</var> functions.</p></li>
	</li>
	</ul>		</ul>
	~~<b>~~Usage~~</b>~~
	<p>The $~~ECBDSET~~ function returns the following return codes:</p>		==Usage==
			<p>The <var>$EcbDset</var> function returns the following return codes:</p>
	<table>		<table>
	<tr class="head">		<tr class="head">
Line 22:		Line 25:
	<th>Meaning</th>		<th>Meaning</th>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">0 </td>		<td align="right">0 </td>
	<td>Success</td>		<td>Success</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">2 </td>		<td align="right">2 </td>
	<td>Bad argument specified</td>		<td>Bad argument specified</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">3 </td>		<td align="right">3 </td>
	<td>NECBS parameter is not specified or is zero</td>		<td>NECBS parameter is not specified or is zero</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">4 </td>		<td align="right">4 </td>
	<td>The first argument is less than one or greater than the NECBS parameter</td>		<td>The first argument is less than one or greater than the NECBS parameter</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">5 </td>		<td align="right">5 </td>
	<td>NUSERS = 1</td>		<td>NUSERS = 1</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">7 </td>		<td align="right">7 </td>
	<td>$~~ECBDSET~~ missing data argument</td>		<td><var>$EcbDset</var> missing data argument</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">8 </td>		<td align="right">8 </td>
	<td>No argument specified</td>		<td>No argument specified</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">9</td>		<td align="right">9</td>
	<td>Extended quiesce environment error; issue a $~~STATUSD~~ function call for details.</td>		<td>Extended quiesce environment error; issue a <var>$StatusD</var> function call for details.</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">11</td>		<td align="right">11</td>
	<td>Cannot be issued after QZSIG has been posted</td>		<td>Cannot be issued after QZSIG has been posted</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">12</td>		<td align="right">12</td>
	<td>Invalid argument CPQZ or invalid argument following QZSIG</td>		<td>Invalid argument CPQZ or invalid argument following QZSIG</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">13</td>		<td align="right">13</td>
Line 67:		Line 81:
	</tr>		</tr>
	</table>		</table>
	<p class="note"><b>Note:</b> The $~~ECBDSET~~ function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by $~~ECBDSET~~ is accessible using the $~~ECBDGET~~ function.</p>		<p class="note"><b>Note:</b> The <var>$EcbDset</var> function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by <var>$EcbDset</var> is accessible using the <var>[[$EcbDget]]</var> function.</p>
	~~<b>~~Example~~</b>~~
	<p class="code">%X=$~~ECBDSET~~(1,'This is about managing user threads')		==Example==
			<p class="code">%x=$Ecbdset(1,'This is about managing user threads')
	</p>		</p>

	[[Category:SOUL $functions]]		[[Category:SOUL $functions]]

Admin: Admin moved page $ECBDSET to $EcbDset without leaving a redirect: caps in title

2014-09-08T18:52:33Z

Admin moved page $ECBDSET to $EcbDset without leaving a redirect: caps in title

← Older revision	Revision as of 18:52, 8 September 2014
(No difference)

Alex: Automatically generated page update

2013-04-20T13:18:56Z

Automatically generated page update

New page

Function
Set string data associated with an Event Control Block (ECB)
Syntax
$ECBDSET({ECB-number | 'CPQZ'},{'string'})

Where:
<ul>
<li>ECB-number is a string with a numeric value from one to the NECBS parameter that identifies the ECB in which to store the string of data. The ECB-number can be expressed as a numeric literal, a %variable, or a field name.</li>
</li>
<li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility.</li>
To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. When CPQZ is specified, the value of the $ECBDSET function can be non-null (except for error values) during only extended quiesce. CPQZ is internally cleared to null when the system exits extended quiesce.
</li>
<li>string can be up to 255 bytes long. It can be a numeric, a literal, a %variable, or a field name.</li>
Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the $POST or $ECBDSET functions.
</li>
</ul>
Usage
The $ECBDSET function returns the following return codes:
<table>
<tr class="head">
<th>Return code </th>
<th>Meaning</th>
</tr>
<tr>
<td align="right">0 </td>
<td>Success</td>
</tr>
<tr>
<td align="right">2 </td>
<td>Bad argument specified</td>
</tr>
<tr>
<td align="right">3 </td>
<td>NECBS parameter is not specified or is zero</td>
</tr>
<tr>
<td align="right">4 </td>
<td>The first argument is less than one or greater than the NECBS parameter</td>
</tr>
<tr>
<td align="right">5 </td>
<td>NUSERS = 1</td>
</tr>
<tr>
<td align="right">7 </td>
<td>$ECBDSET missing data argument</td>
</tr>
<tr>
<td align="right">8 </td>
<td>No argument specified</td>
</tr>
<tr>
<td align="right">9</td>
<td>Extended quiesce environment error; issue a $STATUSD function call for details.</td>
</tr>
<tr>
<td align="right">11</td>
<td>Cannot be issued after QZSIG has been posted</td>
</tr>
<tr>
<td align="right">12</td>
<td>Invalid argument CPQZ or invalid argument following QZSIG</td>
</tr>
<tr>
<td align="right">13</td>
<td>Cannot be issued outside of extended quiesce</td>
</tr>
</table>
Note: The $ECBDSET function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by $ECBDSET is accessible using the $ECBDGET function.
Example
%X=$ECBDSET(1,'This is about managing user threads')

[[Category:SOUL $functions]]