$EcbTest - Revision history

Dme: /* Usage */

2017-12-28T00:44:20Z

Usage

← Older revision		Revision as of 00:44, 28 December 2017
Line 17:		Line 17:
	==Usage==		==Usage==
	<p>		<p>
	Use the <var>$EcbTest</var> function to obtain ECB status, posted or not, through the return code. The post code, if set by <var>$Post</var>, is accessible using the <var>$StatusD</var> function. The following return codes apply to the <var>$EcbTest</var> function:</p>		Use the <var>$EcbTest</var> function to obtain ECB status, posted or not, through the return code. The post code, if set by <var>[[$Post]]</var>, is accessible using the <var>[[$StatusD]]</var> function. The following return codes apply to the <var>$EcbTest</var> function:</p>
	<table>		<table>
	<tr class="head">		<tr class="head">

Dme: /* Example */

2017-12-27T12:40:08Z

Example

@@ Line 60: / Line 60: @@
 <p class="code">%rc=$ecbTest(1)
 </p>
 [[Category:SOUL $functions]]

Dme: /* Example */

2017-12-27T12:07:58Z

Example

← Older revision		Revision as of 12:07, 27 December 2017
Line 58:		Line 58:

	==Example==		==Example==
	<p class="code">%rc=$~~Ecbtest~~(1)		<p class="code">%rc=$ecbTest(1)
	</p>		</p>

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

Dme: /* Syntax */

2017-12-27T12:05:36Z

Syntax

← Older revision		Revision as of 12:05, 27 December 2017
Line 10:		Line 10:
	<li><var class="term">ECB-number</var> is a string with a numeric value from one to the <var>[[NECBS and NOECBS parameters\|NECBS]]</var> parameter that identifies which ECB to test for its post status. The <var class="term">ECB-number</var> value 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 and NOECBS parameters\|NECBS]]</var> parameter that identifies which ECB to test for its post status. The <var class="term">ECB-number</var> value can be expressed as a numeric literal, a %variable, or a field name.</li>

	<li><var>CPQZ</var> is a named ECB used by the [[NonStop/204 facility to automatically post an extended quiesce. To use CPQZ, you need not set the <var>NECBS</var> parameter. <var>CPQZ</var> can be expressed as a literal, a %variable, or a field name. </li>		<li><var>CPQZ</var> is a named ECB used by the [[NonStop/204 facility\|NonStop/204]] facility to automatically post an extended quiesce. To use CPQZ, you need not set the <var>NECBS</var> parameter. <var>CPQZ</var> can be expressed as a literal, a %variable, or a field name. </li>

	<li><var>QZSIG</var> is a named ECB used by the [[~~System and media recovery#Media recovery~~ NonStop/204\|NonStop/204]] facility to signal when an external backup is completed. To use <var>QZSIG</var>, you need not set the <var>NECBS</var> parameter. <var>QZSIG</var> can be expressed as a literal, a %variable, or a field name. </li>		<li><var>QZSIG</var> is a named ECB used by the [[NonStop/204 facility\|NonStop/204]] facility to signal when an external backup is completed. To use <var>QZSIG</var>, you need not set the <var>NECBS</var> parameter. <var>QZSIG</var> can be expressed as a literal, a %variable, or a field name. </li>
	</ul>		</ul>

JAL: remove Sys Man guide

2014-11-03T19:13:52Z

remove Sys Man guide

← Older revision		Revision as of 19:13, 3 November 2014
Line 3:		Line 3:

	==Syntax==		==Syntax==
	<p class="~~code~~">$EcbTest(ECB-number \| 'CPQZ' \| 'QZSIG')		<p class="syntax">$EcbTest(<span class="term">ECB-number</span> \| 'CPQZ' \| 'QZSIG')
	</p>		</p>
	<p>		<p>
	Where:</p>		Where:</p>
	<ul>		<ul>
	<li>ECB-number is a string with a numeric value from one to the NECBS parameter that identifies which ECB to test for its post status. 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 and NOECBS parameters\|NECBS]]</var> parameter that identifies which ECB to test for its post status. The <var class="term">ECB-number</var> value 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 the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility~~. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. </li>		<li><var>CPQZ</var> is a named ECB used by the [[NonStop/204 facility to automatically post an extended quiesce. To use CPQZ, you need not set the <var>NECBS</var> parameter. <var>CPQZ</var> can be expressed as a literal, a %variable, or a field name. </li>

	<li>QZSIG is a named ECB used by the ~~NonStop/204 facility to signal when an external backup is completed. See~~ [[System and media recovery#Media recovery NonStop/204\|~~Media recovery~~ NonStop/204]] ~~for~~ an ~~explanation of the facility~~. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name. </li>		<li><var>QZSIG</var> is a named ECB used by the [[System and media recovery#Media recovery NonStop/204\|NonStop/204]] facility to signal when an external backup is completed. To use <var>QZSIG</var>, you need not set the <var>NECBS</var> parameter. <var>QZSIG</var> can be expressed as a literal, a %variable, or a field name. </li>
	</ul>		</ul>

JAL at 19:24, 8 September 2014

2014-09-08T19:24:32Z

← Older revision		Revision as of 19:24, 8 September 2014
Line 12:		Line 12:
	<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. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a 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 the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. </li>

	<li>QZSIG is a named ECB used by the NonStop/204 facility to signal when an external backup is completed. See ~~the Rocket <var class="product">Model ~~204</~~var> System Manager's Guide~~ for an explanation of the facility. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name. </li>		<li>QZSIG is a named ECB used by the NonStop/204 facility to signal when an external backup is completed. See [[System and media recovery#Media recovery NonStop/204\|Media recovery NonStop/204]] for an explanation of the facility. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name. </li>
	</ul>		</ul>

Admin at 19:16, 8 September 2014

2014-09-08T19:16:27Z

← Older revision		Revision as of 19:16, 8 September 2014
Line 1:		Line 1:
	<b>~~Function~~</b>		<p>
	<p>~~Check~~ an Event Control Block (ECB) to see if it is posted</p>		<var>$EcbTest</var> checks an Event Control Block (ECB) to see if it is posted</p>
	~~<b>~~Syntax~~</b>~~
	<p class="code">$~~ECBTEST~~(ECB-number \| 'CPQZ' \| 'QZSIG')		==Syntax==
			<p class="code">$EcbTest(ECB-number \| 'CPQZ' \| 'QZSIG')
	</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 which ECB to test for its post status. 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 which ECB to test for its post status. 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. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a 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 the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. </li>
	~~</li>~~
	<li>QZSIG is a named ECB used by the NonStop/204 facility to signal when an external backup is completed. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name. </li>		<li>QZSIG is a named ECB used by the NonStop/204 facility to signal when an external backup is completed. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name. </li>
	~~</li>~~
	</ul>		</ul>
	~~<b>~~Usage~~</b>~~
	<p>Use the $~~ECBTEST~~ function to obtain ECB status, posted or not, through the return code. The post code, if set by $~~POST~~, is accessible using the $~~STATUSD~~ function. The following return codes apply to the $~~ECBTEST~~ function:</p>		==Usage==
			<p>
			Use the <var>$EcbTest</var> function to obtain ECB status, posted or not, through the return code. The post code, if set by <var>$Post</var>, is accessible using the <var>$StatusD</var> function. The following return codes apply to the <var>$EcbTest</var> function:</p>
	<table>		<table>
	<tr class="head">		<tr class="head">
Line 53:		Line 56:
	</tr>		</tr>
	</table>		</table>
	~~<b>~~Example~~</b>~~
	<p class="code">%RC=$~~ECBTEST~~(1)		==Example==
			<p class="code">%rc=$Ecbtest(1)
	</p>		</p>

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

Admin: Admin moved page $ECBTEST to $EcbTest without leaving a redirect: caps in title

2014-09-08T18:49:12Z

Admin moved page $ECBTEST to $EcbTest without leaving a redirect: caps in title

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

Alex: Automatically generated page update

2013-04-20T13:18:56Z

Automatically generated page update

New page

Function
Check an Event Control Block (ECB) to see if it is posted
Syntax
$ECBTEST(ECB-number | 'CPQZ' | 'QZSIG')

Where:
<ul>
<li>ECB-number is a string with a numeric value from one to the NECBS parameter that identifies which ECB to test for its post status. 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. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. </li>
</li>
<li>QZSIG is a named ECB used by the NonStop/204 facility to signal when an external backup is completed. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name. </li>
</li>
</ul>
Usage
Use the $ECBTEST function to obtain ECB status, posted or not, through the return code. The post code, if set by $POST, is accessible using the $STATUSD function. The following return codes apply to the $ECBTEST function:
<table>
<tr class="head">
<th>Return code </th>
<th>Meaning</th>
</tr>
<tr>
<td align="right">0 </td>
<td>Not posted</td>
</tr>
<tr>
<td align="right">1 </td>
<td>Posted</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">8</td>
<td>No argument specified</td>
</tr>
<tr>
<td align="right">9</td>
<td>Checkpointing inactive, if using extended quiesce named ECBs, CPQZ or QZSIG</td>
</tr>
</table>
Example
%RC=$ECBTEST(1)

[[Category:SOUL $functions]]