$EcbDGet: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Admin moved page $ECBDGET to $EcbDget without leaving a redirect: caps in title)
m (add italics)
 
(6 intermediate revisions by 4 users not shown)
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="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>
 
<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&nbsp;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 19: 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>
</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 <var>[[$EcbDSet]]</var> function or the <var>[[$Post]]</var> function for the specified ECB.</p>
<p class="code">%X = $ECBDGET(17)
<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==
<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]]

Latest revision as of 17:40, 2 January 2018

$EcbDGet gets string data associated with an Event Control Block (ECB).

Syntax

$EcbDGetT(ECB-number | 'CPQZ')

Where:

  • 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.
  • CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See Media recovery NonStop/204 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. 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.

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.

Return code Meaning
2 Bad argument specified
3 NECBS parameter is not specified or is zero
4 The input argument is less than one or greater than the NECBS parameter
5 NUSERS = 1
8 No argument specified
9 Checkpoints are inactive, if using extended quiesce ECB named CPQZ
12 Invalid argument CPQZ or invalid argument following QZSIG.

The $EcbDGet function retrieves data set by either the $EcbDSet function or the $Post function for the specified ECB.

The post code, set by the $Post function, can be obtained by the $StatusD function issued after the $EcbTest function.

Example

%x = $ecbdGet(17)

See also

The ECB-related $functions are: