$EcbDSet: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Admin moved page $ECBDSET to $EcbDset without leaving a redirect: caps in title)
mNo edit summary
Line 1: Line 1:
<b>Function</b>
<var>$EcbDset</var> sets string data associated with an Event Control Block (ECB).
<p>Set string data associated with an Event Control Block (ECB)</p>
 
<b>Syntax</b>
==Syntax==
<p class="code">$ECBDSET({ECB-number | 'CPQZ'},{'string'})
<p class="code">$EcbDset({ECB-number | 'CPQZ'},{'string'})
</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 in which to store the string of data. 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 in which to store the string of data. 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>$EcbDset</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>
</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>
 
<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 $ECBDSET 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>
<li>string can be up to 255 bytes long. It can be a numeric, a literal, a %variable, or a field name.</li>
<li>string can be up to 255 bytes long. It can be a numeric, a literal, a %variable, or a field name.</li>
<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the $POST or $ECBDSET functions.</p>
<p>Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the <var>$Post</var> or <var>$EcbDset</var> functions.</p></li>
</li>
</ul>
</ul>
<b>Usage</b>
 
<p>The $ECBDSET function returns the following return codes:</p>
==Usage==
<p>The <var>$EcbDset</var> function returns the following return codes:</p>
<table>
<table>
<tr class="head">
<tr class="head">
Line 22: Line 25:
<th>Meaning</th>
<th>Meaning</th>
</tr>
</tr>
<tr>
<tr>
<td align="right">0 </td>
<td align="right">0 </td>
<td>Success</td>
<td>Success</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">2 </td>
<td align="right">2 </td>
<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 first argument is less than one or greater than the NECBS parameter</td>
<td>The first 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">7 </td>
<td align="right">7 </td>
<td>$ECBDSET missing data argument</td>
<td><var>$EcbDset</var> missing data argument</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>Extended quiesce environment error; issue a $STATUSD function call for details.</td>
<td>Extended quiesce environment error; issue a <var>$StatusD</var> function call for details.</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">11</td>
<td align="right">11</td>
<td>Cannot be issued after QZSIG has been posted</td>
<td>Cannot be issued after QZSIG has been posted</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">12</td>
<td align="right">12</td>
<td>Invalid argument CPQZ or invalid argument following QZSIG</td>
<td>Invalid argument CPQZ or invalid argument following QZSIG</td>
</tr>
</tr>
<tr>
<tr>
<td align="right">13</td>
<td align="right">13</td>
Line 67: Line 81:
</tr>
</tr>
</table>
</table>
<p class="note"><b>Note:</b> The $ECBDSET function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by $ECBDSET is accessible using the $ECBDGET function.</p>
<p class="note"><b>Note:</b> The <var>$EcbDset</var> function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by <var>$EcbDset</var> is accessible using the <var>[[$EcbDget]]</var> function.</p>
<b>Example</b>
 
<p class="code">%X=$ECBDSET(1,'This is about managing user threads')
==Example==
<p class="code">%x=$Ecbdset(1,'This is about managing user threads')
</p>
</p>
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Revision as of 19:36, 8 September 2014

$EcbDset sets string data associated with an Event Control Block (ECB).

Syntax

$EcbDset({ECB-number | 'CPQZ'},{'string'})

Where:

  • ECB-number is a string with a numeric value from one to the NECBS parameter that identifies the ECB in which to store the string of data. 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 $EcbDset 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.

  • string can be up to 255 bytes long. It can be a numeric, a literal, a %variable, or a field name.
  • Unless explicitly reset to null, data strings persist whether or not the ECB is posted. Depending on the sequence, data strings can be changed by either the $Post or $EcbDset functions.

Usage

The $EcbDset function returns the following return codes:

Return code Meaning
0 Success
2 Bad argument specified
3 NECBS parameter is not specified or is zero
4 The first argument is less than one or greater than the NECBS parameter
5 NUSERS = 1
7 $EcbDset missing data argument
8 No argument specified
9 Extended quiesce environment error; issue a $StatusD function call for details.
11 Cannot be issued after QZSIG has been posted
12 Invalid argument CPQZ or invalid argument following QZSIG
13 Cannot be issued outside of extended quiesce

Note: The $EcbDset function associates a string with an ECB, regardless of whether the ECB is posted or not. String data set by $EcbDset is accessible using the $EcbDget function.

Example

%x=$Ecbdset(1,'This is about managing user threads')