$ChkMod: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (add <var>'s) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
<p>Use the $ChkMod function after a [[Full- | <p> | ||
Use the <var>$ChkMod</var> function after a <var>[[Full-screen feature#READ SCREEN statement|READ SCREEN]]</var> or <var>[[Full-screen feature#REREAD SCREEN statement|REREAD SCREEN]]</var> statement to determine whether the terminal operator entered data for any full-screen input fields or for a specific input field. See a discussion of the full-screen feature in [[Full-screen feature#Full-screen processing|Full-screen processing]]. </p> | |||
<b>Syntax</b> | <b>Syntax</b> | ||
<p>The format of the $ChkMod function is:</p> | <p> | ||
The format of the <var>$ChkMod</var> function is:</p> | |||
<p class="code">$ChkMod (screenname <var>[</var>, inputname<var>]</var>) | <p class="code">$ChkMod (screenname <var>[</var>, inputname<var>]</var>) | ||
</p> | </p> | ||
<ul> | <ul> | ||
<li>Both the screenname and inputname arguments are expected to be string expressions and can include quoted strings, %variables, field names, or functions. < | <li>Both the <var class="term">screenname</var> and <var class="term">inputname</var> arguments are expected to be string expressions and can include quoted strings, %variables, field names, or functions. | ||
< | <p> | ||
If <var class="term">screenname</var> and/or <var class="term">inputname</var> are quoted strings, the name must be enclosed in single quotation marks:</p> | |||
<p class="code">$chkmod ('EMPSCRN', 'NAME') | <p class="code">$chkmod ('EMPSCRN', 'NAME') | ||
</p></li> | </p></li> | ||
<li>If inputname (representing an input field on the specified screen) is not included in the function call, $ChkMod returns the number of input fields for which the terminal operator entered data. | <li>If <var class="term">inputname</var> (representing an input field on the specified screen) is not included in the function call, <var>$ChkMod</var> returns the number of input fields for which the terminal operator entered data. | ||
<p>If inputname is specified, $ChkMod returns a value of 0 if the input field was not modified. $ChkMod returns a value of 1 if the field was modified. </p> | <p>If <var class="term">inputname</var> is specified, <var>$ChkMod</var> returns a value of 0 if the input field was not modified. <var>$ChkMod</var> returns a value of 1 if the field was modified. </p> | ||
</li> | </li> | ||
</ul> | </ul> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] | ||
Latest revision as of 17:48, 22 January 2018
Use the $ChkMod function after a READ SCREEN or REREAD SCREEN statement to determine whether the terminal operator entered data for any full-screen input fields or for a specific input field. See a discussion of the full-screen feature in Full-screen processing.
Syntax
The format of the $ChkMod function is:
$ChkMod (screenname [, inputname])
- Both the screenname and inputname arguments are expected to be string expressions and can include quoted strings, %variables, field names, or functions.
If screenname and/or inputname are quoted strings, the name must be enclosed in single quotation marks:
$chkmod ('EMPSCRN', 'NAME')
- If inputname (representing an input field on the specified screen) is not included in the function call, $ChkMod returns the number of input fields for which the terminal operator entered data.
If inputname is specified, $ChkMod returns a value of 0 if the input field was not modified. $ChkMod returns a value of 1 if the field was modified.