$EcbDSet: Difference between revisions
(→Syntax) |
m (minor formatting) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
==Syntax== | ==Syntax== | ||
<p class=" | <p class="syntax">$EcbDSet({<span class="term">ECB-number</span> | 'CPQZ'},{'<span class="term">string</span>'}) | ||
</p> | </p> | ||
<p> | <p> | ||
Where:</p> | Where:</p> | ||
<ul> | <ul> | ||
<li>ECB-number is a numeric value (which may range from one to the value of the <var>[[NECBS parameter|NECBS]]</var> parameter) that identifies the ECB in which to store the string of data.</li> | <li><var class="term">ECB-number</var> is a numeric value (which may range from one to the value of the <var>[[NECBS parameter|NECBS]]</var> parameter) that identifies the ECB in which to store the string of data.</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. | <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. | ||
| Line 14: | Line 14: | ||
</li> | </li> | ||
<li>string can be up to 255 bytes long | <li><var class="term">string</var> can be up to 255 bytes long.</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 <var>$Post</var> or <var>$EcbDSet</var> functions.</p></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 <var>$Post</var> or <var>$EcbDSet</var> functions.</p></li> | ||
</ul> | </ul> | ||
| Line 84: | Line 84: | ||
==Example== | ==Example== | ||
<p class="code">%x=$ | <p class="code">%x=$ecbdSet(1,'This is about managing user threads') | ||
</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:18, 2 January 2018
$EcbDSet sets string data associated with an Event Control Block (ECB).
Syntax
$EcbDSet({ECB-number | 'CPQZ'},{'string'})
Where:
- ECB-number is a numeric value (which may range from one to the value of the NECBS parameter) that identifies the ECB in which to store the string of data.
- 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.
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')
See also
The ECB-related $functions are: