$EcbDGet: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| Line 1: | Line 1: | ||
< | <var>$EcbDget</var> gets string data associated with an Event Control Block (ECB). | ||
==Syntax== | |||
<p class="code">$ | <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>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See | <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 $ | <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> | ||
<p>When the $ | ==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 $ | <p> | ||
The <var>$EcbDget</var> function retrieves data set by either the $ECBDSET or $POST functions for the specified ECB.</p> | |||
<p class="code">% | |||
==Example== | |||
<p class="code">%x = $Ecbdget(17) | |||
</p> | </p> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] | ||
Revision as of 19:41, 8 September 2014
$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 or $POST functions for the specified ECB.
Example
%x = $Ecbdget(17)