$UnPost: Difference between revisions
mNo edit summary |
|||
Line 2: | Line 2: | ||
<p>Resets a specified Event Control Block (ECB) to an unposted state, meaning that the event has not yet occurred or has not recurred. Resets the post code to zero.</p> | <p>Resets a specified Event Control Block (ECB) to an unposted state, meaning that the event has not yet occurred or has not recurred. Resets the post code to zero.</p> | ||
<b>Syntax</b> | <b>Syntax</b> | ||
<p class="code">$ | <p class="code">$UnPost(ECB-number) | ||
</p> | </p> | ||
<p>Where:</p> | <p>Where:</p> | ||
<p>ECB-number is a numeric value from one to the NECBS parameter that identifies the ECB to be unposted. The ECB-number can be expressed as a numeric literal, a literal enclosed in quotation marks, a %variable, or a field name.</p> | <p>ECB-number is a numeric value from one to the NECBS parameter that identifies the ECB to be unposted. The ECB-number can be expressed as a numeric literal, a literal enclosed in quotation marks, a %variable, or a field name.</p> | ||
<b>Usage</b> | <b>Usage</b> | ||
<p>Use the $ | <p>Use the <var>$UnPost</var> function to unpost a specified, numbered ECB. An ECB must be unposted before another post or wait on this ECB takes place. The <var>$Post</var> and <var>$Wait</var> functions do not unpost an ECB, so that a subsequent wait on the same ECB cannot take place, because the ECB is still posted from the previous posting. </p> | ||
<p>Use the $ | <p>Use the <var>$Post</var>, <var>$UnPost</var>, and $WAIT functions to coordinate processing between threads for numbered ECBs. For the extended quiesce ECB, QZSIG, only the $WAIT and $POST functions are valid.</p> | ||
<p>$ | <p> | ||
<p class="note"><b>Note:</b> Even in a non-multiprocessing environment, the $ | <var>$UnPost</var> does not reset the contents of the post code or string data set by the <var>$Post</var> or $ECBDSET functions for the specified ECB.</p> | ||
<p>The following return codes apply to the $ | <p class="note"><b>Note:</b> Even in a non-multiprocessing environment, the <var>$UnPost</var> function should be used with extreme care. Unposting an ECB while users are waiting on it may keep users in a wait state forever or until the next <var>$Post</var> function is issued.</p> | ||
<p> | |||
The following return codes apply to the <var>$UnPost</var> function:</p> | |||
<table> | <table> | ||
<tr class="head"> | <tr class="head"> | ||
Line 46: | Line 48: | ||
</tr> | </tr> | ||
</table> | </table> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] |
Revision as of 19:10, 8 September 2014
Function
Resets a specified Event Control Block (ECB) to an unposted state, meaning that the event has not yet occurred or has not recurred. Resets the post code to zero.
Syntax
$UnPost(ECB-number)
Where:
ECB-number is a numeric value from one to the NECBS parameter that identifies the ECB to be unposted. The ECB-number can be expressed as a numeric literal, a literal enclosed in quotation marks, a %variable, or a field name.
Usage
Use the $UnPost function to unpost a specified, numbered ECB. An ECB must be unposted before another post or wait on this ECB takes place. The $Post and $Wait functions do not unpost an ECB, so that a subsequent wait on the same ECB cannot take place, because the ECB is still posted from the previous posting.
Use the $Post, $UnPost, and $WAIT functions to coordinate processing between threads for numbered ECBs. For the extended quiesce ECB, QZSIG, only the $WAIT and $POST functions are valid.
$UnPost does not reset the contents of the post code or string data set by the $Post or $ECBDSET functions for the specified ECB.
Note: Even in a non-multiprocessing environment, the $UnPost function should be used with extreme care. Unposting an ECB while users are waiting on it may keep users in a wait state forever or until the next $Post function is issued.
The following return codes apply to the $UnPost function:
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 |
8 | No argument specified |
12 | Invalid argument CPQZ or invalid argument following QZSIG |