$EcbDGet - Revision history

JAL: add italics

2018-01-02T17:40:14Z

add italics

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

	==Syntax==		==Syntax==
	<p class="~~code~~">$EcbDGetT(ECB-number \| 'CPQZ')		<p class="syntax">$EcbDGetT(<span class="term">ECB-number</span> \| 'CPQZ')
	</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 from which to retrieve the text. The ECB-number can be expressed as a numeric literal, a %variable, or a field name.</li>		<li><var class="term">ECB-number</var> is a string with a numeric value from one to the <var>NECBS</var> parameter that identifies the ECB from which to retrieve the text. 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.		<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 21:		Line 21:
	<th>Meaning</th>		<th>Meaning</th>
	</tr>		</tr>

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

	<tr>		<tr>
	<td ~~align="right"~~>3 </td>		<td>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>4 </td>
	<td>The input argument is less than one or greater than the NECBS parameter</td>		<td>The input argument is less than one or greater than the NECBS parameter</td>
	</tr>		</tr>

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

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

	<tr>		<tr>
	<td ~~align="right"~~>9</td>		<td>9</td>
	<td>Checkpoints are inactive, if using extended quiesce ECB named CPQZ</td>		<td>Checkpoints are inactive, if using extended quiesce ECB named CPQZ</td>
	</tr>		</tr>

	<tr>		<tr>
	<td ~~align="right"~~>12</td>		<td>12</td>
	<td>Invalid argument CPQZ or invalid argument following QZSIG.</td>		<td>Invalid argument CPQZ or invalid argument following QZSIG.</td>
	</tr>		</tr>
Line 58:		Line 59:
	<p>		<p>
	The <var>$EcbDGet</var> function retrieves data set by either the <var>[[$EcbDSet]]</var> function or the <var>[[$Post]]</var> function for the specified ECB.</p>		The <var>$EcbDGet</var> function retrieves data set by either the <var>[[$EcbDSet]]</var> function or the <var>[[$Post]]</var> function for the specified ECB.</p>
	<p>The post code, set by the <var>$Post</var> function, can be obtained by the <var>[[$StatusD]]</var> function issued after the <var>[[$EcbTest]]</var> function.		<p>
			The post code, set by the <var>$Post</var> function, can be obtained by the <var>[[$StatusD]]</var> function issued after the <var>[[$EcbTest]]</var> function.

	==Example==		==Example==

Dme: /* Usage */

2017-12-28T00:45:38Z

Usage

← Older revision		Revision as of 00:45, 28 December 2017
Line 57:		Line 57:
	</table>		</table>
	<p>		<p>
	The <var>$EcbDGet</var> function retrieves data set by either the <var>$EcbDSet</var> or <var>$Post</var> ~~functions~~ for the specified ECB.</p>		The <var>$EcbDGet</var> function retrieves data set by either the <var>[[$EcbDSet]]</var> function or the <var>[[$Post]]</var> function for the specified ECB.</p>
			<p>The post code, set by the <var>$Post</var> function, can be obtained by the <var>[[$StatusD]]</var> function issued after the <var>[[$EcbTest]]</var> function.

	==Example==		==Example==

Dme: /* Example */

2017-12-27T12:36:54Z

Example

← Older revision		Revision as of 12:36, 27 December 2017
Line 60:		Line 60:

	==Example==		==Example==
	<p class="code">%x = $~~Ecbdget~~(17)		<p class="code">%x = $ecbdGet(17)
	</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]]

JAL at 00:39, 11 October 2014

2014-10-11T00:39:42Z

← Older revision		Revision as of 00:39, 11 October 2014
Line 57:		Line 57:
	</table>		</table>
	<p>		<p>
	The <var>$EcbDGet</var> function retrieves data set by either the $~~ECBDSET~~ or $~~POST~~ functions for the specified ECB.</p>		The <var>$EcbDGet</var> function retrieves data set by either the <var>$EcbDSet</var> or <var>$Post</var> functions for the specified ECB.</p>

	==Example==		==Example==

Admin: Admin moved page $EcbDget to $EcbDGet without leaving a redirect: typo in name

2014-09-08T20:18:48Z

Admin moved page $EcbDget to $EcbDGet 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 1:		Line 1:
	<var>$~~EcbDget~~</var> gets string data associated with an Event Control Block (ECB).		<var>$EcbDGet</var> gets string data associated with an Event Control Block (ECB).

	==Syntax==		==Syntax==
	<p class="code">$~~EcbDgetT~~(ECB-number \| 'CPQZ')		<p class="code">$EcbDGetT(ECB-number \| 'CPQZ')
	</p>		</p>
	<p>Where:</p>		<p>Where:</p>
Line 10:		Line 10:
	<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>$~~EcbDget~~</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>		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>$EcbDGet</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>
	</ul>		</ul>

	==Usage==		==Usage==
	<p>		<p>
	When the <var>$~~EcbDget~~</var> function is successful, it returns your data as a text string up to 255 bytes long. If you make a coding mistake, you may receive one of the following return codes as a string.</p>		When the <var>$EcbDGet</var> function is successful, it returns your data as a text string up to 255 bytes long. If you make a coding mistake, you may receive one of the following return codes as a string.</p>
	<table>		<table>
	<tr class="head">		<tr class="head">
Line 57:		Line 57:
	</table>		</table>
	<p>		<p>
	The <var>$~~EcbDget~~</var> function retrieves data set by either the $ECBDSET or $POST functions for the specified ECB.</p>		The <var>$EcbDGet</var> function retrieves data set by either the $ECBDSET or $POST functions for the specified ECB.</p>

	==Example==		==Example==

JAL at 19:41, 8 September 2014

2014-09-08T19:41:46Z

← Older revision		Revision as of 19:41, 8 September 2014
Line 1:		Line 1:
	<b>~~Function~~</b>		<var>$EcbDget</var> gets string data associated with an Event Control Block (ECB).
	<p>~~Get~~ string data associated with an Event Control Block (ECB)~~</p>~~
	~~<b>~~Syntax~~</b>~~		==Syntax==
	<p class="code">$~~ECBDGET~~(ECB-number \| 'CPQZ')		<p class="code">$EcbDgetT(ECB-number \| 'CPQZ')
	</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 from which to retrieve the text. 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 from which to retrieve the text. 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>~~		<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 $~~ECBDGET~~ 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>		<p>
	</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 <var>$EcbDget</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>
	</ul>		</ul>
	~~<b>~~Usage~~</b>~~
	<p>When the $~~ECBDGET~~ function is successful, it returns your data as a text string up to 255 bytes long. If you make a coding mistake, you may receive one of the following return codes as a string.</p>		==Usage==
			<p>
			When the <var>$EcbDget</var> function is successful, it returns your data as a text string up to 255 bytes long. If you make a coding mistake, you may receive one of the following return codes as a string.</p>
	<table>		<table>
	<tr class="head">		<tr class="head">
Line 23:		Line 25:
	<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 input argument is less than one or greater than the NECBS parameter</td>		<td>The input 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">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>Checkpoints are inactive, if using extended quiesce ECB named CPQZ</td>		<td>Checkpoints are inactive, if using extended quiesce ECB named CPQZ</td>
	</tr>		</tr>

	<tr>		<tr>
	<td align="right">12</td>		<td align="right">12</td>
Line 48:		Line 56:
	</tr>		</tr>
	</table>		</table>
	<p>The $~~ECBDGET~~ function retrieves data set by either the $ECBDSET or $POST functions for the specified ECB.</p>		<p>
	~~<b>~~Example~~</b>~~		The <var>$EcbDget</var> function retrieves data set by either the $ECBDSET or $POST functions for the specified ECB.</p>
	<p class="code">%X = $~~ECBDGET~~(17)
			==Example==
			<p class="code">%x = $Ecbdget(17)
	</p>		</p>

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

Admin: Admin moved page $ECBDGET to $EcbDget without leaving a redirect: caps in title

2014-09-08T18:51:48Z

Admin moved page $ECBDGET to $EcbDget without leaving a redirect: caps in title

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

Alex: Automatically generated page update

2013-04-20T13:18:55Z

Automatically generated page update

New page

Function
Get string data associated with an Event Control Block (ECB)
Syntax
$ECBDGET(ECB-number | 'CPQZ')

Where:
<ul>
<li>ECB-number is a string with a numeric value from one to the NECBS parameter that identifies the ECB from which to retrieve the text. 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 $ECBDGET 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>
</ul>
Usage
When the $ECBDGET function is successful, it returns your data as a text string up to 255 bytes long. If you make a coding mistake, you may receive one of the following return codes as a string.
<table>
<tr class="head">
<th>Return code </th>
<th>Meaning</th>
</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 input 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">8 </td>
<td>No argument specified</td>
</tr>
<tr>
<td align="right">9</td>
<td>Checkpoints are inactive, if using extended quiesce ECB named CPQZ</td>
</tr>
<tr>
<td align="right">12</td>
<td>Invalid argument CPQZ or invalid argument following QZSIG.</td>
</tr>
</table>
The $ECBDGET function retrieves data set by either the $ECBDSET or $POST functions for the specified ECB.
Example
%X = $ECBDGET(17)

[[Category:SOUL $functions]]