View source for $EcbDGet

<var>$EcbDGet</var> gets string data associated with an Event Control Block (ECB).

==Syntax==
<p class="code">$EcbDGetT(ECB-number | 'CPQZ')
</p>
<p>Where:</p>
<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>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>$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>

==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>
<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>
<p>
The <var>$EcbDGet</var> function retrieves data set by either the $ECBDSET or $POST functions for the specified ECB.</p>

==Example==
<p class="code">%x = $Ecbdget(17)
</p>

[[Category:SOUL $functions]]