View source for Statement syntax

This page summarizes SOUL syntax and conventions, which are discussed in more detail throughout this wiki. The SOUL statements are listed in alphabetical order.  Many of the section titles or syntax blocks contain links to the wiki page describing the statement or syntax phrase. A [[#Other syntax|later section]] provides other SOUL syntax information, including links to [[#tokens|information about the "tokens"]] of SOUL, such as names in SOUL.
<p>
All SOUL statements can be used between a <var>[[BEGIN command|Begin]]</var> (or <var>[[MORE command|More]]</var>) command and an <var>[[End statement|End]]</var> statement. </p>
<p>External Call Facility (ECF) statements are listed under <var>[[#External|External]]</var>.</p>
<p>
Various other [[List of Model 204 commands|Model 204 commands]] also have effects on the results of a SOUL request. </p>
<p>
The following notations prefix some of the statements in the presentation of the SOUL syntax: </p>
<p class="code"><nowiki>*
**
+
++
C
</nowiki></p>
<p>
See the [[#Notation conventions|notation conventions]] section for an explanation of these usages, as well as other general comments about understanding the syntax of SOUL. 
</p>
&nbsp; <!-- Separates intro from toc -->
<div id="User Language statements"></div>  <!-- In case there are links -->
<div id="SOUL statements"></div>  <div id="SOUL syntax"></div>
<!--To make above link targets go to toc:-->
<!--==SOUL statements in alphabetical order==-->

===[[Data maintenance#ADD statement|ADD]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">ADD <span class="term">fieldname</span> = <span class="squareb">{</span><span class="term">value</span> <span class="squareb">|</span> (<span class="term">expression</span>)<span class="squareb">}</span> </p></td></tr>
</table>
 
<p class="syntaxUL">[[Large Object field processing for non-FILEORG X'100' files#Adding Large Object fields|ADD]] <span class="term">lob-name</span>=BUFFER,<span class="term">position</span>,<span class="term">length</span><span class="squareb">[</span>RESERVE <span class="term">n</span> <span class="squareb">[</span>BYTES<span class="squareb">]</span><span class="squareb">]</span>
</p>

===ARRAY===
 
<p class="syntaxUL">ARRAY <span class="squareb">[</span><span class="term">arrayname</span><span class="squareb">]</span> OCCURS <span class="squareb">{</span><span class="term">n</span> <span class="squareb">|</span> UNKNOWN<span class="squareb">}</span>
 DEPENDING ON <span class="squareb">{</span><span class="term">itemname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 <span class="squareb">[</span>AFTER <span class="squareb">{</span><span class="term">itemname</span> <span class="squareb">|</span> <span class="term">arrayname</span><span class="squareb">}</span>
 <span class="squareb">|</span> AT <span class="squareb">{</span><span class="term">position</span> <span class="squareb">|</span> <span class="term">itemname</span> <span class="squareb">|</span> <span class="term">imagename1</span> <span class="squareb">|</span> <span class="term">arrayname</span><span class="squareb">}</span><span class="squareb">]</span>
</p>
 
===[[Assert statement|Assert]]===
 
{{Template:Assert statement syntax}}

===[[Report_generation#AUDIT_statement|AUDIT]]===
 
<p class="syntaxUL">AUDIT <span class="term">[[#Print specification syntax|print-specifications]]</span>
</p>

===[[Audit All Fieldgroup Information statement|Audit All Fieldgroup Information]] (AAFGI)===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td>{{Template:AAFGI statement syntax}} </td></tr>
</table>

===AUDIT ALL INFORMATION===
 
<p class="syntaxUL"><span class="squareb">{</span>[[Basic SOUL statements and commands#AUDIT ALL INFORMATION statement|AUDIT ALL INFORMATION]] <span class="squareb">|</span> AAI<span class="squareb">}</span> <span class="squareb">[</span>CTOFIELDS<span class="squareb">]</span>
</p>

===BACKOUT===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(C)]] </td>
<td><p class="syntaxUL">[[Data recovery#Manual backout|BACKOUT]]</p> </td></tr>
</table>

===BYPASS===
 
<p class="syntaxUL">BYPASS <span class="squareb">[</span>PENDING STATEMENT<span class="squareb">]</span> </p>
 
===CALL===
 
<p class="syntaxUL">CALL <span class="squareb">{</span><span class="term">label</span> <span class="squareb">|</span> <span class="term">subname</span>
 <span class="squareb">[</span>(<span class="squareb">[</span><span class="term">expression</span> <span class="squareb">|</span> <span class="term">%variable</span> <span class="squareb">|</span> <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">]</span> <span class="squareb">[</span>,...<span class="squareb">]</span>)<span class="squareb">]</span><span class="squareb">}</span>
</p>
 
===[[Data maintenance#Change statement|Change]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td>{{Template:Change fieldname statement syntax (basic)}} </td></tr>
</table>
 
{{Template:Change lob-fieldname statement syntax}}

===[[Global_features#Using_the_CLEAR_statement|CLEAR]]===
 
{{Template:Clear statement syntax}}

===CLEAR LIST===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL">[[Lists#Clearing a list|CLEAR LIST]] <span class="term">listname</span> </p></td></tr>
</table>

===CLEAR ON===
 
{{Template:Clear On statement syntax}}

===CLEAR TAG===
 
<p class="syntaxUL">CLEAR TAG <span class="squareb">{</span><span class="term">screenname</span> <span class="squareb">|</span> <span class="term">%screenname</span>:<span class="term">inputname</span><span class="squareb">}</span>
</p>
 
===CLOSE===
 
<p class="syntaxUL">CLOSE
 <span class="squareb">{</span>DATASET <span class="squareb">{</span><span class="term">ext-filename</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 <span class="squareb">|</span> <span class="squareb">[</span>EXTERNAL<span class="squareb">]</span> <span class="squareb">{</span><span class="term">ext-filename</span> <span class="squareb">|</span> TERMINAL <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span><span class="squareb">}</span>
</p>
 
===CLOSE PROCESS===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+C)]] </td>
<td><p class="syntaxUL">CLOSE PROCESS    <BR>     <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> <span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>    <BR>     <span class="squareb">[</span>SYNCLEVEL <span class="squareb">|</span> FLUSH <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">]</span> </p></td></tr>
</table>

<p class="syntaxUL">CLOSE PROCESS
 <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> <span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 <span class="squareb">[</span>SYNCLEVEL <span class="squareb">|</span> CONFIRM <span class="squareb">|</span> FLUSH <span class="squareb">|</span> ERROR <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">]</span>
</p>

===[[Commit statement|Commit]]===
 
{{Template:Commit statement syntax}}

===[[Horizon SOUL interface#Confirm statement|Confirm]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td>{{Template:Confirm statement syntax}} </td></tr>
</table>

===[[Horizon SOUL interface#Confirmed statement|Confirmed]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td>{{Template:Confirmed statement syntax}} </td></tr>
</table>

===CONTINUE===
 
<p class="syntaxUL">CONTINUE</p>
 
===COUNT OCCURRENCES OF===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">COUNT OCCURRENCES OF <span class="term">fieldname</span></p></td></tr>
</table>
 
===COUNT RECORDS===
 
<p class="syntaxUL">COUNT RECORDS <span class="squareb">{</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">}</span></p>
 
===<b id="declare"></b>DECLARE===
 
<p class="syntaxUL"><span class="squareb">[</span>DECLARE<span class="squareb">]</span> <span class="term">declaration</span>
</p>
 
<p>
where <var class="term">declaration</var> is one of the following: </p>

<div style="margin-left: 20px; background-color: #fBfBfB;">
<ul style="font-family: Consolas,monospace">
<li>LABEL <i>labelname</i> <span class="squareb">[</span>GLOBAL <span class="squareb">|</span> COMMON<span class="squareb">]</span>
 
<li>[[Lists#DECLARE LIST syntax|LIST]] listname <span class="squareb">[</span>IN <span class="squareb">[</span>FILE <span class="squareb">|</span> <span class="squareb">[</span>PERM <span class="squareb">|</span> TEMP<span class="squareb">]</span> GROUP<span class="squareb">]</span><span class="squareb">]</span> <i>name</i><span class="squareb">]</span> <span class="squareb">[</span>GLOBAL <span class="squareb">|</span> COMMON<span class="squareb">]</span>
 
<li>IMAGE <i>imagename</i><span class="squareb">[</span>AT <span class="squareb">{</span><i>itemname</i> <span class="squareb">|</span> <i>imagename1</i> <span class="squareb">|</span> <i>arrayname</i><span class="squareb">}</span> <br>
       <span class="squareb">|</span> GLOBAL <span class="squareb">[</span>PERMANENT <span class="squareb">|</span> TEMPORARY<span class="squareb">]</span> <br>
       <span class="squareb">|</span> <span class="squareb">[</span>PERMANENT <span class="squareb">|</span> TEMPORARY<span class="squareb">]</span> GLOBAL <span class="squareb">|</span> COMMON<span class="squareb">]</span>
 
<li>MENU <i>menuname</i> <span class="squareb">[</span>GLOBAL <span class="squareb">[</span>PERMANENT <span class="squareb">|</span> TEMPORARY<span class="squareb">]</span> <br>
      <span class="squareb">|</span> <span class="squareb">[</span>PERMANENT <span class="squareb">|</span> TEMPORARY<span class="squareb">]</span> GLOBAL <span class="squareb">|</span> COMMON<span class="squareb">]</span>
 
<li>SCREEN <i>screenname</i> <span class="squareb">[</span>GLOBAL <span class="squareb">[</span>PERMANENT <span class="squareb">|</span> TEMPORARY<span class="squareb">]</span> <br>
        <span class="squareb">|</span> <span class="squareb">[</span>PERMANENT <span class="squareb">|</span> TEMPORARY<span class="squareb">]</span> GLOBAL <span class="squareb">|</span> COMMON<span class="squareb">]</span>
 
<li><i>%variable</i> <span class="squareb">[</span>IS<span class="squareb">]</span> <span class="squareb">{</span>FIXED <span class="squareb">[</span>DP <i>n</i><span class="squareb">]</span> <span class="squareb">|</span> FLOAT<span class="squareb">}</span> <span class="squareb">[</span>ARRAY (<i>d1</i> <span class="squareb">[</span>,<i>d2</i> <span class="squareb">[</span>,<i>d3</i><span class="squareb">]</span><span class="squareb">]</span>)<span class="squareb">]</span> <br>
           <span class="squareb">[</span>[[Initial clause in %variable declaration|Initial]](<i>numeric-expression</i>)<span class="squareb">]</span> <span class="squareb">[</span>STATIC<span class="squareb">]</span> <span class="squareb">[</span>COMMON<span class="squareb">]</span>
 
<li><i>%variable</i> <span class="squareb">[</span>IS<span class="squareb">]</span> STRING <span class="squareb">[</span>LEN <i>n</i><span class="squareb">]</span> <span class="squareb">[</span>DP <span class="squareb">{</span><i>n</i> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span>ARRAY (<i>d1</i> <span class="squareb">[</span>,<i>d2</i><span class="squareb">[</span>,<i>d3</i><span class="squareb">]</span><span class="squareb">]</span>)<span class="squareb">]</span> <br>
           <span class="squareb">[</span>NO FIELD SAVE<span class="squareb">]</span> <span class="squareb">[</span>COMMON<span class="squareb">]</span> <br>
           <span class="squareb">[</span>[[Initial clause in %variable declaration|Initial]]('<i>EBCDIC-string</i>' <span class="squareb">|</span> <i>expression</i>)<span class="squareb">]</span> <span class="squareb">[</span>STATIC<span class="squareb">]</span>
 
<li>SUBROUTINE <i>subname</i> <span class="squareb">[</span>(<i>type</i> <span class="squareb">[</span>INPUT <span class="squareb">|</span> OUTPUT <span class="squareb">|</span> INPUT OUTPUT<span class="squareb">]</span> <span class="squareb">[</span>,...<span class="squareb">]</span>)<span class="squareb">]</span>
</ul>
</div> <!-- declare indent/background --> 

<div style="margin-left: 20px;>
<p>
and where <var class="term">type</var> is one of the following:</p>
</div>

<div style="margin-left: 40px; background-color: #fBfBfB;">
<ul>
<li>Scalar %variable of the following format:
<ul style="font-family: Consolas,monospace">
<li><span class="squareb">{</span>STRING <span class="squareb">[</span>LEN<span class="squareb">]</span> <i>n</i> <span class="squareb">[</span>DP <span class="squareb">{</span><i>n</i> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">|</span> <span class="squareb">[</span>FIXED <span class="squareb">[</span>DP <i>n</i><span class="squareb">]</span> <span class="squareb">|</span> FLOAT<span class="squareb">]</span><span class="squareb">}</span> </li></ul>
</li>
 
<li>Array %variable of the following format:
<ul style="font-family: Consolas,monospace">
<li><span class="squareb">{</span>STRING <span class="squareb">[</span>LEN <i>n</i><span class="squareb">]</span> <span class="squareb">[</span>DP <span class="squareb">[</span><i>n</i> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span>ARRAY (* <span class="squareb">[</span>,*<span class="squareb">[</span>,*<span class="squareb">]</span><span class="squareb">]</span>) <span class="squareb">[</span>NO FIELD SAVE<span class="squareb">]</span><span class="squareb">]</span> <br>
 <span class="squareb">|</span> <span class="squareb">[</span>FIXED <span class="squareb">[</span>DP <i>n</i><span class="squareb">]</span> <span class="squareb">|</span> FLOAT<span class="squareb">]</span> <span class="squareb">[</span>ARRAY (* <span class="squareb">[</span>,*<span class="squareb">[</span>,*<span class="squareb">]</span><span class="squareb">]</span>)<span class="squareb">]</span><span class="squareb">}</span> </li></ul>
</li>
 
<li>A list of records of the following format:
<ul style="font-family: Consolas,monospace">
<li><span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="squareb">[</span>IN <span class="squareb">{</span>FILE <span class="squareb">|</span> <span class="squareb">[</span>PERM <span class="squareb">|</span> TEMP<span class="squareb">]</span> GROUP<span class="squareb">}</span> <i>name</i><span class="squareb">]</span> </li></ul>
</li>
</ul>
 
</div> <!-- type indentation/background -->

====See also====

<ul>
<li>[[Using variables and values in computation]]
</ul>

===DEFAULT CURSOR===
 
<p class="syntaxUL">DEFAULT CURSOR <span class="squareb">[</span>READ <span class="squareb">|</span> REREAD <span class="squareb">|</span> PRINT<span class="squareb">]</span>
               <span class="squareb">{</span>ITEMID <span class="term">n</span> <span class="squareb">|</span> <span class="term">itemname</span> <span class="squareb">|</span> ROW <span class="term">n</span> COLUMN <span class="term">m</span><span class="squareb">}</span>
</p>
 
===DEFAULT===
 
<p class="syntaxUL">DEFAULT <span class="squareb">{</span>TITLE
        <span class="squareb">|</span> PROMPT
        <span class="squareb">|</span> INPUT <span class="squareb">[</span>DEBLANK <span class="squareb">|</span> NODEBLANK<span class="squareb">]</span> <span class="squareb">[</span>PAD WITH '<span class="term">c</span>'<span class="squareb">]</span> <span class="squareb">[</span>LEN <span class="term">m</span> <span class="squareb">[</span>DP <span class="squareb">[</span><span class="term">k</span> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span><span class="squareb">]</span> <span class="squareb">[</span>UPCASE <span class="squareb">|</span> NOCASE<span class="squareb">]</span>
        <span class="squareb">|</span> <span class="squareb">[</span>TAG <span class="squareb">[</span><span class="term">attributes</span><span class="squareb">]</span> <span class="squareb">[</span>WITH '<span class="term">c</span>'<span class="squareb">]</span><span class="squareb">}</span>
        <span class="squareb">[</span><span class="squareb">[</span>READ<span class="squareb">]</span> <span class="term">attributes</span><span class="squareb">]</span> <span class="squareb">[</span>REREAD <span class="term">attributes</span><span class="squareb">]</span> <span class="squareb">[</span>PRINT <span class="term">attributes</span><span class="squareb">]</span>

DEFAULT SKIP <span class="term">n</span> POSITIONS<span class="squareb">[</span>S<span class="squareb">]</span>
             <span class="squareb">[</span>INITIAL <span class="squareb">{</span>NULL <span class="squareb">|</span> <span class="term">character</span> <span class="squareb">|</span> BLANK<span class="squareb">}</span><span class="squareb">]</span>

DEFAULT <span class="squareb">[</span>TYPE<span class="squareb">]</span>
 <span class="squareb">{</span>STRING <span class="squareb">|</span> BINARY <span class="squareb">|</span> PACKED <span class="squareb">|</span> ZONED <span class="squareb">|</span> FLOAT <span class="squareb">|</span> EFORMAT<span class="squareb">}</span>
 <span class="squareb">{</span>LEN <span class="squareb">{</span><span class="term">n</span> <span class="squareb">|</span> UNKNOWN<span class="squareb">}</span> <span class="squareb">|</span> BITS <span class="term">n</span> <span class="squareb">|</span> DIGITS <span class="term">n</span><span class="squareb">}</span>
 <span class="squareb">[</span>DP <span class="squareb">{</span><span class="term">k</span> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span>BP <span class="term">n</span><span class="squareb">]</span>
 <span class="squareb">[</span>SIGNED <span class="squareb">|</span> UNSIGNED<span class="squareb">]</span> <span class="squareb">[</span>PAD <span class="squareb">{</span>BLANK <span class="squareb">|</span> <span class="term">character</span> <span class="squareb">|</span> NULL<span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">[</span>STRIP <span class="squareb">|</span> NOSTRIP<span class="squareb">]</span> <span class="squareb">[</span>JUSTIFY <span class="squareb">{</span>LEFT <span class="squareb">|</span> RIGHT<span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">[</span>INITIAL <span class="squareb">{</span>BLANK <span class="squareb">|</span> ZERO <span class="squareb">|</span> NULL <span class="squareb">|</span> <span class="term">literal</span><span class="squareb">}</span><span class="squareb">]</span>
</p>

===DELETE===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">[[Data maintenance#DELETE statement|DELETE]] <span class="term">fieldname</span> <span class="squareb">[</span>(<span class="term">[[Processing_multiply_occurring_fields_and_field_groups#DELETE_statement_rules|subscript]]</span>)<span class="squareb">]</span> <span class="squareb">[</span><b></b>= <span class="term">value</span> <span class="squareb">|</span> (<span class="term">expression</span>)<span class="squareb">]</span>
</p></td></tr>
</table>

<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">[[Data maintenance#Deleting a field group|DELETE FIELDGROUP]] <span class="squareb">[</span><span class="term">fieldgroupname</span><span class="squareb">]</span> <span class="squareb">[</span>(<span class="term">[[Processing_multiply_occurring_fields_and_field_groups#DELETE_statement_rules|subscript]]</span>)<span class="squareb">]</span> <span class="squareb">[</span><b></b>= <span class="term">value</span> <span class="squareb">|</span> (<span class="term">expression</span>)<span class="squareb">]</span>
</p></td></tr>
</table>

===DELETE EACH===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">DELETE EACH <span class="term">fieldname</span></p> </td></tr>
</table>
 
===[[Data maintenance#DELETE RECORD statement|DELETE RECORD]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">DELETE RECORD </p> </td></tr>
</table>

===DELETE RECORDS===
 
<p class="syntaxUL">DELETE <span class="squareb">[</span>ALL<span class="squareb">]</span> RECORDS <span class="squareb">{</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">}</span>
</p>
 
===END BLOCK===
 
<p class="syntaxUL">END BLOCK <span class="term">label</span> </p>
 
===End===
 
<p class="syntaxUL">END <span class="squareb">{</span>FIND <span class="squareb">|</span> IF <span class="squareb">|</span> FOR <span class="squareb">|</span> ON <span class="squareb">|</span> REPEAT <span class="squareb">|</span> STORE <span class="squareb">|</span> SUBROUTINE<span class="squareb">}</span> [<span class="term">label</span><span class="squareb">]</span>

END <span class="squareb">{</span>ARRAY <span class="squareb">|</span> IMAGE <span class="squareb">|</span> MENU <span class="squareb">|</span> SCREEN<span class="squareb">}</span>

[[End statement|End]] <span class="squareb">[</span>MORE <span class="squareb">|</span> NORUN <span class="squareb">|</span> USE<span class="squareb">]</span>...</p>

===END UPDATE===
 
<p class="syntaxUL">END UPDATE</p>

===[[External statement|External]]===
 
{{Template:External statement syntax}}

===FILE RECORDS===
 
<p class="syntaxUL">FILE RECORDS <span class="squareb">{</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">}</span>
             UNDER <span class="term">fieldname</span> = <span class="squareb">{</span><span class="term">value</span> <span class="squareb">|</span> (<span class="term">expression</span>)<span class="squareb">}</span>
</p>
 
===[[Find Records statement|Find Records]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL"><span class="squareb">{</span>FIND <span class="squareb">[</span><span class="squareb">[</span>ALL<span class="squareb">]</span> RECORDS<span class="squareb">]</span> <span class="squareb">|</span> FD <span class="squareb">}</span>         <br>   <span class="squareb">[</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">]</span>         <br>   <span class="squareb">[</span>FOR WHICH <span class="squareb">|</span> WITH<span class="squareb">]</span> <span class="term">[[#Retrieval condition syntax|retrieval-conditions]]</span></p></td></tr>
</table>

===[[Find And Reserve statement|Find And Reserve]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL"><span class="squareb">{</span>FIND AND RESERVE <span class="squareb">[</span><span class="squareb">[</span>ALL<span class="squareb">]</span> RECORDS<span class="squareb">]</span> <span class="squareb">|</span> FDR<span class="squareb">}</span>  <br>   <span class="squareb">[</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">]</span>  <br>   <span class="squareb">[</span>FOR WHICH <span class="squareb">|</span> WITH<span class="squareb">]</span> <span class="term">[[#Retrieval condition syntax|retrieval-conditions]]</span> </p></td></tr>
</table>

===[[Value loops#Find All Values statement|Find Values Of (FDV)]]===
<table class="noBorder">
<tr>
<td style="padding:0em">{{Template: Find Values Of statement syntax}} </td></tr>
</table>

===FIND AND PRINT COUNT===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL"><span class="squareb">{</span>Find And Print Count <span class="squareb">|</span> FPC<span class="squareb">}</span>  <br>   <span class="squareb">[</span><span class="term">[[#Retrieval condition syntax|retrieval-conditions]]</span><span class="squareb">]</span>
</p></td></tr>
</table>

===[[Find Records statement|Find Without Locks]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL"><span class="squareb">{</span>Find Without Locks <span class="squareb">[</span><span class="squareb">[</span>ALL<span class="squareb">]</span> Records<span class="squareb">]</span> <span class="squareb">|</span> FDWOL<span class="squareb">}</span><br>   <span class="squareb">[</span>In <span class="term">label</span> <span class="squareb">|</span> On <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">]</span>
   <span class="squareb">[</span>For Which <span class="squareb">|</span> With<span class="squareb">]</span> <span class="term">[[#Retrieval condition syntax|retrieval-conditions]]</span></p></td></tr>
</table>

===FLUSH PROCESS===
 
<p class="syntaxUL">FLUSH PROCESS <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> <span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span></p>
 
===FOR EACH OCCURRENCE===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">FOR <span class="squareb">{</span>EACH <span class="squareb">|</span> <span class="term">k</span><span class="squareb">}</span> <span class="squareb">{</span>OCCURRENCE <span class="squareb">|</span> OCCURRENCES<span class="squareb">}</span> <span class="term">OF fieldname</span> </p></td></tr>
</table>
 
===<b id="FOR EACH RECORD"></b>[[Record loops#For Each Record statement|For Each Record]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td>{{Template:For Each Record statement syntax}}</td></tr>
</table>
<p class="note"><b>Note:</b> For <var class="term">retrieval-conditions</var>, see [[#Retrieval condition syntax|Retrieval condition syntax]], below. </p>

===FOR EACH VALUE OF===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL">FOR <span class="squareb">{</span>EACH <span class="squareb">|</span> <span class="term">k</span><span class="squareb">}</span> <span class="squareb">{</span>VALUE <span class="squareb">|</span> VALUES<span class="squareb">}</span> <span class="term">OF fieldname</span> <br>    <span class="squareb">[</span>FROM <span class="squareb">{</span><span class="term">value1</span> <span class="squareb">|</span> (<span class="term">expression1</span>)<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span>TO <span class="squareb">{</span><span class="term">value2</span> <span class="squareb">|</span> (<span class="term">expression2</span>)<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span><span class="squareb">[</span>NOT<span class="squareb">]</span> LIKE <span class="term">pattern</span><span class="squareb">]</span> <br>    <span class="squareb">[</span>IN <span class="squareb">[</span>ASCENDING <span class="squareb">|</span> DESCENDING<span class="squareb">]</span> <span class="squareb">[</span>CHARACTER <span class="squareb">|</span> NUMERICAL<span class="squareb">]</span> <span class="squareb">[</span>RIGHT-ADJUSTED<span class="squareb">]</span> ORDER<span class="squareb">]</span>
</p></td></tr>
</table>
 
===FOR EACH VALUE IN===
 
   <p class="syntaxUL">FOR <span class="squareb">{</span>EACH <span class="squareb">|</span> <span class="term">k</span><span class="squareb">}</span> <span class="squareb">{</span>VALUE <span class="squareb">|</span> VALUES<span class="squareb">}</span> IN <span class="term">label</span> </p>
 
===FOR RECORD NUMBER===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL">FOR RECORD NUMBER <span class="squareb">{</span><span class="term">value</span> <span class="squareb">|</span> (<span class="term">expression</span>)<span class="squareb">}</span>
</p></td></tr>
</table>
 
===FOR RECORD NUMBER IN===
 
<p class="syntaxUL">FOR RECORD NUMBER <span class="squareb">{</span><span class="term">value</span> <span class="squareb">|</span> IN <span class="term">label</span><span class="squareb">}</span> <span class="squareb">[</span>OPTIMIZING FNV<span class="squareb">]</span>
</p>

===[[For %i statement|For %var From %exp1 To %exp2 By %exp3]]===
 
{{Template:For %i statement syntax}}
 
<p class="note"><b>Note:</b> The BY clause, when omitted, defaults to a value of 1.</p>

===IDENTIFY===
 
<p class="syntaxUL">IDENTIFY
 <span class="squareb">{</span><span class="squareb">[</span>IMAGE<span class="squareb">]</span> <span class="term">imagename</span>
 <span class="squareb">|</span> <span class="term">%imagename</span>:<span class="term">itemname</span> LEN <span class="squareb">{</span><span class="term">n</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 <span class="squareb">|</span> <span class="term">%imagename</span>:<span class="term">arrayname</span> OCCURS <span class="squareb">{</span><span class="term">n</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span><span class="squareb">}</span>
</p>

===<b id="IF...THEN...ELSE"></b>[[If statement|If]]...Then...ElseIf...Else===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(C)]] </td>
<td><p class="syntaxUL">IF <span class="term">expression</span> THEN <span class="term">statements</span>   <BR>   <span class="squareb">[</span>ELSE <span class="term">statements</span> <span class="squareb">|</span> ELSEIF <span class="term">expression</span> THEN <span class="term">statements</span><span class="squareb">]</span>
</p></td></tr>
</table>

===IMAGE===
 
<p class="syntaxUL"><span class="squareb">[</span>DECLARE<span class="squareb">]</span> IMAGE <span class="term">imagename</span>
 <span class="squareb">[</span>GLOBAL <span class="squareb">[</span>PERMANENT <span class="squareb">|</span> TEMPORARY<span class="squareb">]</span>
 <span class="squareb">|</span> <span class="squareb">[</span>PERMANENT <span class="squareb">|</span> TEMPORARY<span class="squareb">]</span> GLOBAL
 <span class="squareb">|</span> COMMON <span class="squareb">[</span>AT <span class="squareb">[</span><span class="term">itemname</span> <span class="squareb">|</span> <span class="term">imagename1</span> <span class="squareb">|</span> <span class="term">arrayname</span><span class="squareb">}</span><span class="squareb">]</span><span class="squareb">]</span>
</p>

===INCLUDE===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL">INCLUDE <span class="term">procedurename</span>  </p></td></tr>
</table>
 
===INPUT===
 
<p class="syntaxUL">INPUT <span class="term">inputname</span> <span class="squareb">[</span>AT <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">n</span><span class="squareb">]</span>
 <span class="squareb">[</span>TO <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">m</span> <span class="squareb">|</span> <span class="squareb">[</span>LEN <span class="term">m</span><span class="squareb">]</span> DP <span class="squareb">{</span><span class="term">k</span> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span><span class="squareb">]</span>
 <span class="squareb">[</span>UPCASE <span class="squareb">|</span> NOCASE<span class="squareb">]</span> <span class="squareb">[</span>DEFAULT '<span class="term">value</span>'<span class="squareb">]</span>
 <span class="squareb">[</span>DEBLANK <span class="squareb">|</span> NODEBLANK<span class="squareb">]</span> <span class="squareb">[</span>PAD WITH '<span class="term">c</span>'<span class="squareb">]</span>
 <span class="squareb">[</span>REQUIRED <span class="squareb">|</span> ALPHA <span class="squareb">|</span> ALPHANUM <span class="squareb">|</span> MUSTFILL
 <span class="squareb">|</span> ONEOF <span class="term">literal</span> <span class="squareb">[</span>, <span class="term">literal</span><span class="squareb">]</span>...
 <span class="squareb">|</span> <span class="squareb">[</span>NUMERIC<span class="squareb">]</span> <span class="squareb">[</span>RANGE <span class="term">lo</span> <span class="squareb">[</span>TO<span class="squareb">]</span> <span class="term">hi</span> <span class="squareb">[</span>AND <span class="term">lo</span> <span class="squareb">[</span>TO<span class="squareb">]</span> <span class="term">hi</span><span class="squareb">]</span> ...<span class="squareb">]</span>
 <span class="squareb">|</span> VERIFY '<span class="term">characters</span>'<span class="squareb">]</span>...
 <span class="squareb">[</span><span class="squareb">[</span>READ<span class="squareb">]</span> <span class="term">attributes</span><span class="squareb">]</span> <span class="squareb">[</span>REREAD <span class="term">attributes</span><span class="squareb">]</span> <span class="squareb">[</span>PRINT <span class="term">attributes</span><span class="squareb">]</span>
 <span class="squareb">[</span>TAG <span class="squareb">[</span><span class="term">attributes</span><span class="squareb">]</span> <span class="squareb">[</span>WITH '<span class="term">c</span>'<span class="squareb">]</span><span class="squareb">]</span> <span class="squareb">[</span>ITEMID <span class="term">n</span><span class="squareb">]</span>
</p>

===INSERT===
 
<p class="syntaxUL">INSERT <span class="term">fieldname</span> <span class="squareb">[</span>(<span class="term">subscript</span>)<span class="squareb">]</span> = <span class="squareb">{</span><span class="term">value</span> <span class="squareb">|</span> (<span class="term">expression</span>)<span class="squareb">}</span>
</p>
 
===[[Horizon SOUL interface#Invite statement|Invite]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td>{{Template:Invite statement syntax}} </td></tr>
</table>
 
===IS===
 
<p class="syntaxUL"><span class="term">itemname</span> IS <span class="squareb">[</span>TYPE<span class="squareb">]</span>
 <span class="squareb">{</span>STRING <span class="squareb">|</span> BINARY <span class="squareb">|</span> PACKED <span class="squareb">|</span> ZONED <span class="squareb">|</span> FLOAT <span class="squareb">|</span> EFORMAT<span class="squareb">}</span>
 <span class="squareb">{</span>LEN <span class="squareb">{</span><span class="term">n</span> <span class="squareb">|</span> UNKNOWN<span class="squareb">}</span> <span class="squareb">|</span> BITS <span class="term">n</span> <span class="squareb">|</span> DIGITS <span class="term">n</span>
 <span class="squareb">|</span> TO <span class="term">position</span><span class="squareb">}</span>
 <span class="squareb">[</span>DP <span class="squareb">{</span><span class="term">k</span> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span>BP <span class="term">n</span><span class="squareb">]</span> <span class="squareb">[</span>SIGNED <span class="squareb">|</span> UNSIGNED<span class="squareb">]</span>
 <span class="squareb">[</span>PAD <span class="squareb">{</span>BLANK <span class="squareb">|</span> <span class="term">character</span> <span class="squareb">|</span> NULL<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span>STRIP <span class="squareb">|</span> NOSTRIP<span class="squareb">]</span>
 <span class="squareb">[</span>ALIGN<span class="squareb">]</span>
 <span class="squareb">[</span>JUSTIFY <span class="squareb">{</span>LEFT <span class="squareb">|</span> RIGHT<span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">[</span>INITIAL <span class="squareb">{</span>BLANK <span class="squareb">|</span> ZERO <span class="squareb">|</span> NULL <span class="squareb">|</span> <span class="term">value</span><span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">[</span>AFTER <span class="squareb">{</span><span class="term">itemname</span> <span class="squareb">|</span> <span class="term">arrayname</span><span class="squareb">}</span>
 <span class="squareb">|</span> AT <span class="squareb">{</span><span class="term">position</span> <span class="squareb">|</span> <span class="term">itemname</span> <span class="squareb">|</span> <span class="term">imagename1</span> <span class="squareb">|</span> <span class="term">arrayname</span><span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">[</span>OCCURS <span class="squareb">{</span><span class="term">n</span> <span class="squareb">[</span>DEPENDING ON <span class="squareb">{</span><span class="term">itemname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">|</span> UNKNOWN<span class="squareb">}</span><span class="squareb">]</span>
</p>
 
===JUMP TO===
 
<p class="syntaxUL">JUMP TO <span class="term">label</span>
 
JUMP TO (<span class="term">label1</span> <span class="squareb">[</span>, <span class="term">label2</span><span class="squareb">]</span> ...) <span class="term">expression</span></p>

===[[Flow of control in User Language#LOOP END statement|Loop End]]===
 
<p class="syntaxUL">Loop End </p>

===[[Loop Next statement|Loop Next]]===
 
<p class="syntaxUL">Loop Next</p>
 
===MAX PFKEY===
 
<p class="syntaxUL">MAX PFKEY <span class="term">n</span> </p>

===<b id="MENU"></b>[[Menu statement or block|Menu]]===

{{Template: Menu statement syntax}}

===MODIFY===
 
<p class="syntaxUL">MODIFY <span class="squareb">{</span><span class="term">%menuname</span>:<span class="term">itemname</span> <span class="squareb">|</span> <span class="term">%screenname</span>:<span class="term">itemname</span><span class="squareb">}</span>
 <span class="squareb">[</span>TO<span class="squareb">]</span> <span class="term">attributes</span> <span class="squareb">[</span><span class="squareb">[</span>FOR<span class="squareb">]</span> <span class="squareb">{</span>ALL <span class="squareb">|</span> READ <span class="squareb">|</span> REREAD <span class="squareb">|</span> TAB
 <span class="squareb">|</span> PRINT<span class="squareb">}</span><span class="squareb">]</span>
</p>
 
===MODIFY BUFFER===
 
<p class="syntaxUL">MODIFY BUFFER <span class="squareb">[</span>SIZE=<span class="term">n</span>
 <span class="squareb">|</span> <span class="term">%variable</span> <span class="squareb">[</span>PRESERVE <span class="squareb">|</span> NOPRESERVE<span class="squareb">]</span><span class="squareb">]</span>
 <span class="squareb">[</span>FILL <span class="squareb">[</span>X'<span class="term">nn</span>'<span class="squareb">]</span> <span class="squareb">|</span> CLEAR<span class="squareb">]</span>
</p>
 
===NEW PAGE===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(C)]] </td>
<td><p class="syntaxUL">NEW PAGE  </p></td></tr>
</table>
 
===[[Note statement|Note]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">Note <span class="squareb">{</span><span class="term">fieldname</span> <span class="squareb">[</span>(<span class="term">subscript</span>)<span class="squareb">]</span><span class="squareb">}</span> </p></td></tr>
</table>
<p class="syntaxUL">Note '<span class="term">string</span>' 
</p>

===[[On statement|On]]===
 
<p class="syntaxUL">[[On statement|On]] <span class="squareb">{</span>Attention <span class="squareb">|</span> Error <span class="squareb">|</span> Field Constraint Conflict
   <span class="squareb">|</span> Find Conflict <span class="squareb">|</span> Missing File <span class="squareb">|</span> Missing Member
   <span class="squareb">|</span> Record Locking Conflict<span class="squareb">}</span>
   <span class="term">statements</span>
End On <span class="squareb">[</span><span class="term">label</span><span class="squareb">]</span>
</p>

===Open===
 
{{Template:Open (External I/O) statement syntax}}

<p></p>  <!--Don't ask me why!-->
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(C)]] </td>
<td>{{Template:Open and OpenC statements syntax}} </td></tr>
</table>

===OPEN PROCESS===
 
<p class="syntaxUL">OPEN PROCESS <span class="squareb">{</span><span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 <span class="squareb">[</span>CID <span class="squareb">{</span><span class="term">name</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span><span class="squareb">]</span> </p>

<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td><p class="syntaxUL">OPEN PROCESS <span class="squareb">{</span><span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>   <br>    <span class="squareb">[</span>CID <span class="squareb">{</span><span class="term">name</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span><span class="squareb">]</span>   <br>    <span class="squareb">{</span><span class="term">outbound-options</span> <span class="squareb">|</span> <span class="term">inbound-options</span><span class="squareb">}</span>
</p></td></tr>
</table>
 
<div style="margin-left: 30px; background-color: #fBfBfB;">
<p>
where <var class="term">outbound-options</var> are:</p>
<ul style="font-family: Consolas,monospace">
<li><span class="squareb">[</span>AT DESTINATION<span class="squareb">]</span> <span class="squareb">[</span>WITH<span class="squareb">]</span> <span class="squareb">[</span>USERID <span class="squareb">{</span><i>%variable</i> <span class="squareb">|</span> '<i>string</i>'<span class="squareb">}</span><span class="squareb">]</span>
 
<li><span class="squareb">[</span>PASSWORD <span class="squareb">{</span><i>%variable</i> <span class="squareb">|</span> '<i>string</i>'<span class="squareb">}</span><span class="squareb">]</span>
 
<li>[<span class="squareb">{</span>ACCOUNT <span class="squareb">|</span> PROFILE <span class="squareb">{</span>%<i>%variable</i> <span class="squareb">|</span> '<i>string</i>'<span class="squareb">}</span><span class="squareb">]</span>
 
<li><span class="squareb">[</span>INITIAL <span class="squareb">{</span>DATA '<i>string</i>' <span class="squareb">|</span> DATA <i>%variable</i> <span class="squareb">|</span> IMAGE <i>imagename</i><span class="squareb">]</span> ...<span class="squareb">]</span>
</ul>
<p>
and <var class="term">inbound-options</var> are:</p>
 
<ul style="font-family: Consolas,monospace">
<li>ACCEPT <span class="squareb">[</span>INITIAL <span class="squareb">{</span>DATA <i>%variable</i> <span class="squareb">|</span> IMAGE <i>image</i><span class="squareb">}</span> ...<span class="squareb">]</span> </li>
</ul>
 
</div> <!-- end indent of options -->

===[[Pause statement|Pause]]===
 
{{Template:Pause statement syntax}}

===PLACE RECORD ON===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">[[Lists#PLACE RECORD and REMOVE RECORD statements|PLACE RECORD ON]] <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span>
</p></td></tr>
</table>

===PLACE RECORDS===
 
<p class="syntaxUL">PLACE RECORDS <span class="squareb">{</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname1</span><span class="squareb">}</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname2</span>
</p>
 
===POSITION===
 
<p class="syntaxUL">POSITION <span class="squareb">{</span>FOUNDSET <span class="term">foundsortset_name</span> <span class="squareb">|</span> LIST <span class="term">list_name</span><span class="squareb">}</span> <span class="squareb">[</span>AT<span class="squareb">]</span> <span class="term">position_name</span></p>
 
<p class="note"><b>Note:</b> Use this form of the POSITION statement with FOR loop processing; see [[Global features#POSITION statement|POSITION statement]].</p>

<p class="syntaxUL">POSITION <span class="squareb">{</span><span class="term">ext-filename</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 AT KEY <span class="term">operator</span><span class="squareb">{</span><span class="term">value</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span></p>

<p class="note"><b>Note:</b> Use this form of the POSITION statement with external file processing using images; see [[Images#POSITION statement|POSITION statement]].</p>

===[[Full-screen feature|PREPARE]]===
 
<p class="syntaxUL">PREPARE
 <span class="squareb">{</span><span class="squareb">[</span>[[Images#PrepareStmtImage|IMAGE]]<span class="squareb">]</span> <span class="term">imagename</span> <span class="squareb">|</span> <span class="squareb">[</span>[[Full-screen feature#PrepareStmtMenu|MENU]]<span class="squareb">]</span> <span class="term">menuname</span>
 <span class="squareb">|</span> <span class="squareb">[</span>[[Full-screen feature#PrepareStmtScrn|SCREEN]]<span class="squareb">]</span> <span class="term">screenname</span><span class="squareb">}</span>
</p>

===Print===
 
<p class="syntaxUL">Print <span class="term">[[#Print specification syntax|printSpecifications]]</span>   </p>

===Print All Fieldgroup Information (PAFGI)===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td>{{Template:PAFGI statement syntax}} </td></tr>
</table>

===[[Print All Information statement|Print All Information]] or [[PAI statement|PAI]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td>{{Template:PAI statement syntax}} </td></tr>
</table>

===PRINT MENU===
 
<p class="syntaxUL">PRINT <span class="squareb">[</span>MENU<span class="squareb">]</span> <span class="term">menuname</span> <span class="squareb">[</span>ALERT<span class="squareb">]</span>
 <span class="squareb">[</span>TITLE <span class="squareb">{</span>'<span class="term">text</span>' <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> <span class="squareb">[</span>AT <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">n</span><span class="squareb">]</span>
 <span class="squareb">[</span>TO <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">m</span> <span class="squareb">|</span> LEN <span class="term">m</span><span class="squareb">]</span> <span class="squareb">[</span><span class="term">attributes</span><span class="squareb">]</span><span class="squareb">]</span>
</p>
 
===PRINT SCREEN===
 
<p class="syntaxUL">PRINT SCREEN <span class="term">screenname</span> <span class="squareb">[</span>ALERT<span class="squareb">]</span> <span class="squareb">[</span><span class="squareb">[</span>WITH<span class="squareb">]</span> CURSOR<span class="squareb">]</span>
 <span class="squareb">[</span>TITLE <span class="squareb">{</span>'<span class="term">text</span>' <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> <span class="squareb">[</span>AT <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">n</span><span class="squareb">]</span>
 <span class="squareb">[</span>TO <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">m</span> <span class="squareb">|</span> LEN <span class="term">m</span><span class="squareb">]</span> <span class="squareb">[</span><span class="term">attributes</span><span class="squareb">]</span><span class="squareb">]</span>
</p>
 
===[[Horizon SOUL interface#Query Process statement|Query Process]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td>{{Template:Query Process statement syntax}} </td></tr>
</table>

===<b id="READ"></b>[[Read Image statement|Read Image]]===
 
{{Template:Read Image statement syntax}}

===READ <i>menuname</i>===
 
<p class="syntaxUL">READ <span class="squareb">[</span>MENU<span class="squareb">]</span> <span class="term">menuname</span> <span class="squareb">[</span>ALERT<span class="squareb">]</span>
 <span class="squareb">[</span>TITLE <span class="squareb">[</span>'<span class="term">text</span>' <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> <span class="squareb">[</span>AT <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">n</span><span class="squareb">]</span>
 <span class="squareb">[</span>TO <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">m</span> <span class="squareb">|</span> LEN <span class="term">m</span><span class="squareb">]</span> <span class="squareb">[</span><span class="term">attributes</span><span class="squareb">]</span><span class="squareb">]</span>
</p>
 
===READ <i>screenname</i>===
 
<p class="syntaxUL">READ <span class="squareb">[</span>SCREEN<span class="squareb">]</span> <span class="term">screenname</span> <span class="squareb">[</span>ALERT<span class="squareb">]</span> <span class="squareb">[</span>NO REREAD<span class="squareb">]</span> <span class="squareb">[</span> <span class="squareb">[</span>WITH<span class="squareb">]</span> CURSOR<span class="squareb">]</span>
 <span class="squareb">[</span>TITLE <span class="squareb">{</span>'<span class="term">text</span>' <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> <span class="squareb">[</span>AT <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">n</span><span class="squareb">]</span>
 <span class="squareb">[</span>TO <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">m</span> <span class="squareb">|</span> LEN <span class="term">m</span><span class="squareb">]</span> <span class="squareb">[</span><span class="term">attributes</span><span class="squareb">]</span><span class="squareb">]</span>
</p>
 
===RECEIVE IMAGE===
 
<p class="syntaxUL">RECEIVE <span class="squareb">{</span>IMAGE <span class="term">imagename</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 FROM <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> <span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> <span class="squareb">[</span>RESULT <span class="term">%variable</span><span class="squareb">]</span> </p>

<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td><p class="syntaxUL">RECEIVE <span class="squareb">{</span>IMAGE <span class="term">imagename</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>   <br>  FROM <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> <span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>   <br>  RESULT <span class="term">%variable</span>
</p></td></tr>
</table>

===[[Release All Records statement|Release All Records]]===
 
{{Template:Release All Records statement syntax}}

===RELEASE POSITION===
 
<p class="syntaxUL">RELEASE POSITION <span class="squareb">{</span><span class="term">ext-filename</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
</p>
 
===[[Release Records statement|Release Records]]===
 
{{Template:Release Records statement syntax}}

===REMEMBER===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">REMEMBER <span class="squareb">[</span>GLOBAL<span class="squareb">]</span> <span class="term">position_name</span>     <br>   <span class="squareb">[</span>IN <span class="term">foundsortset_name</span> <span class="squareb">|</span> ON <span class="term">list_name</span><span class="squareb">]</span>
</p></td></tr>
</table>
 
===REMOVE RECORD FROM===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(**)]] </td>
<td><p class="syntaxUL">[[Lists#PLACE RECORD and REMOVE RECORD statements|REMOVE RECORD FROM]] <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span>
</p></td></tr>
</table>

===REMOVE RECORDS===
 
<p class="syntaxUL">REMOVE RECORDS <span class="squareb">{</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">}</span>
 FROM <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname2</span>
</p>
 
===REPEAT===
 
<p class="syntaxUL">REPEAT <span class="squareb">[</span>FOREVER <span class="squareb">|</span> <span class="term">n</span> TIMES <span class="squareb">|</span> WHILE <span class="term">expression</span><span class="squareb">]</span>
</p>
 
===REREAD===
 
<p class="syntaxUL">REREAD <span class="squareb">[</span>SCREEN<span class="squareb">]</span> <span class="term">screenname</span> <span class="squareb">[</span>ALERT<span class="squareb">]</span> <span class="squareb">[</span><span class="squareb">[</span>WITH<span class="squareb">]</span> CURSOR<span class="squareb">]</span>
 <span class="squareb">[</span>TITLE <span class="squareb">{</span>'<span class="term">text</span>' <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> <span class="squareb">[</span>AT <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">n</span><span class="squareb">]</span>
 <span class="squareb">[</span>TO <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">m</span> <span class="squareb">|</span> LEN <span class="term">m</span><span class="squareb">]</span> <span class="squareb">[</span><span class="term">attributes</span><span class="squareb">]</span><span class="squareb">]</span>
</p>
 
===RESET===
 
<p class="syntaxUL">RESET <span class="squareb">{</span>HEADER <span class="squareb">|</span> TRAILER<span class="squareb">}</span> <span class="term">m</span>
</p>
 
===RETRY===
 
<p class="syntaxUL">RETRY <span class="squareb">[</span>PENDING STATEMENT<span class="squareb">]</span>
</p>
 
===RETURN===
 
<p class="syntaxUL">RETURN
</p>

===<b id="SCREEN"></b>[[Screen statement or block|Screen]]===
 
{{Template:Screen statement syntax}}

===SEND===
 
<p class="syntaxUL">SEND <span class="squareb">{</span>IMAGE <span class="term">imagename</span> <span class="squareb">|</span> '<span class="term">string</span>' <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 TO <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> <span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 <span class="squareb">[</span>REQSEND <span class="term">%variable</span><span class="squareb">]</span>
 <span class="squareb">[</span>FLUSH<span class="squareb">]</span>


<b><sup>(+)</sup></b>SEND <span class="squareb">{</span>IMAGE <span class="term">imagename</span> <span class="squareb">|</span> '<span class="term">string</span>' <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
    TO <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> <span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
    <span class="squareb">[</span>FLUSH <span class="squareb">|</span> CONFIRM<span class="squareb">]</span>
    <span class="squareb">[</span>REQSEND <span class="term">%variable</span><span class="squareb">]</span>
</p>

===[[Horizon SOUL interface#Send Error statement|Send Error]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td>{{Template:Send Error statement syntax}} </td></tr>
</table>
 
===SET===
 
<p class="syntaxUL">SET <span class="squareb">{</span>HEADER <span class="squareb">|</span> TRAILER<span class="squareb">}</span> <span class="term">m</span> <span class="term">[[#Print specification syntax|print-specifications]]</span>
</p>

===[[SetText statement|SetText]]===
 
{{Template:SetText statement syntax}}

===SIGNAL PROCESS===
 
<p class="syntaxUL">SIGNAL PROCESS
 <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> [<span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> <span class="squareb">{</span><span class="term">nnn</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> </p>

<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td><p class="syntaxUL">SIGNAL PROCESS        <br>  <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> [<span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
</p></td></tr>
</table>

===SKIP LINES===
 
<p class="syntaxUL">SKIP <span class="term">n</span> LINE<span class="squareb">[</span>S<span class="squareb">]</span>
</p>
 
===SKIP POSITIONS===
 
<p class="syntaxUL">[<span class="term">itemname</span> IS<span class="squareb">]</span> SKIP <span class="term">n</span> POSITION<span class="squareb">[</span>S<span class="squareb">]</span>
 <span class="squareb">[</span>INITIAL <span class="squareb">{</span>NULL <span class="squareb">|</span> <span class="term">character</span> <span class="squareb">|</span> BLANK<span class="squareb">}</span><span class="squareb">]</span>
</p>
 
===SORT RECORDS===
 
<p class="syntaxUL">SORT [<span class="term">k</span><span class="squareb">]</span> RECORDS <span class="squareb">{</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">}</span>
 BY <span class="term">key</span> <span class="squareb">[</span>AND <span class="term">key</span><span class="squareb">]</span> ...
</p>
 
<div style="margin-left: 20px; background-color: #fBfBfB;">
<p>
where <var class="term">key</var> is:</p>
<ul style="font-family: Consolas,monospace">
<li><i>key</i> = <i>fieldname</i> <br>
       <span class="squareb">[</span>VALUE <span class="squareb">{</span><span class="squareb">[</span>ASCENDING <span class="squareb">|</span> DESCENDING<span class="squareb">]</span> <br>
       <span class="squareb">[</span>CHARACTER <span class="squareb">|</span> NUMERICAL<span class="squareb">]</span> <span class="squareb">|</span> RIGHT-ADJUSTED<span class="squareb">]</span><span class="squareb">}</span> ...<span class="squareb">]</span> </li>
</ul>
 
</div> <!--end key indent -->
 
===SORT RECORD KEYS===
 
<p class="syntaxUL">SORT [<span class="term">k</span><span class="squareb">]</span> RECORD KEYS
 <span class="squareb">{</span>IN <span class="term">label</span> <span class="squareb">|</span> ON <span class="squareb">[</span>LIST<span class="squareb">]</span> <span class="term">listname</span><span class="squareb">}</span>
 BY <span class="term">key</span> <span class="squareb">[</span>AND <span class="term">key</span><span class="squareb">]</span> ...
</p>
 
<div style="margin-left: 20px; background-color: #fBfBfB;">
<p>
where <var class="term">key</var> is:</p>
<ul style="font-family: Consolas,monospace">
<li><i>key</i> = <i>fieldname</i> <br>
       <span class="squareb">[</span>VALUE <span class="squareb">{</span><span class="squareb">[</span>ASCENDING <span class="squareb">|</span> DESCENDING<span class="squareb">]</span> <br>
       <span class="squareb">[</span>CHARACTER <span class="squareb">|</span> NUMERICAL<span class="squareb">]</span> <span class="squareb">|</span> <span class="squareb">[</span>RIGHT-ADJUSTED<span class="squareb">]</span><span class="squareb">}</span> ...<span class="squareb">]</span> </li>
</ul>
 
</div>
 
===SORT VALUE IN===
 
<p class="syntaxUL">SORT VALUE IN <span class="term">label</span> <span class="squareb">[</span>IN <span class="squareb">[</span>ASCENDING <span class="squareb">|</span> DESCENDING<span class="squareb">]</span>
 [<u>CHARACTER</u> <span class="squareb">|</span> NUMERICAL<span class="squareb">]</span> <span class="squareb">|</span> <span class="squareb">[</span>RIGHT-ADJUSTED<span class="squareb">]</span> ORDER<span class="squareb">]</span>
</p>
 
===STOP===
 
<p class="syntaxUL">STOP <span class="squareb">[</span>IF COUNT IN <span class="term">label</span> EXCEEDS <span class="term">n</span><span class="squareb">]</span>
</p>
 
===STORE RECORD===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(*)]] </td>
<td><p class="syntaxUL">STORE RECORD [<span class="term">sort or hash key value</span><span class="squareb">]</span>     <br>   <span class="term">fieldname1</span>=[<span class="term">value1</span> <span class="squareb">|</span> (<span class="term">expression1</span>)<span class="squareb">]</span>     <br>   [<span class="term">fieldname2</span>=(<span class="term">expression</span>)<span class="squareb">]</span>     <br>   ...     <br>   <span class="squareb">[</span>THEN CONTINUE     <br>      <span class="term">statement</span>     <br>      <span class="term">statement</span>     <br>      ...<span class="squareb">]</span>     <br>   END STORE
</p></td></tr>
</table>
 
===SUBROUTINE===
 
<p class="syntaxUL">SUBROUTINE

SUBROUTINE <span class="term">subname</span>
 <span class="squareb">[</span>(<span class="term">formal-parameter</span> <span class="squareb">[</span>INPUT <span class="squareb">|</span> OUTPUT <span class="squareb">|</span> INPUT OUTPUT<span class="squareb">]</span> <span class="squareb">[</span>,...<span class="squareb">]</span>)<span class="squareb">]</span>
</p>
 
<div style="margin-left: 20px; background-color: #fBfBfB;">
<p>
where <var class="term">formal-parameter</var> is one of the following:</p>
<ul style="font-family: Consolas,monospace">
<li><i>%variable</i> <span class="squareb">[</span>IS STRING <span class="squareb">[</span>LEN <i>n</i><span class="squareb">]</span> <span class="squareb">[</span>DP <span class="squareb">{</span><i>n</i> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span>ARRAY (*<span class="squareb">[</span>,*<span class="squareb">[</span>,*<span class="squareb">]</span><span class="squareb">]</span>) <span class="squareb">[</span>NO FS<span class="squareb">]</span><span class="squareb">]</span> <br>
           <span class="squareb">|</span> IS <span class="squareb">{</span>FIXED <span class="squareb">[</span>DP <i>n</i><span class="squareb">]</span> <span class="squareb">|</span> FLOAT<span class="squareb">}</span> <span class="squareb">[</span>ARRAY (*<span class="squareb">[</span>,*<span class="squareb">[</span>,*<span class="squareb">]</span><span class="squareb">]</span>)<span class="squareb">]</span><span class="squareb">]</span>
 
<li>LIST <i>listname</i> <span class="squareb">[</span>IN <span class="squareb">[</span>FILE <span class="squareb">|</span> <span class="squareb">[</span>PERM <span class="squareb">|</span> TEMP<span class="squareb">]</span> GROUP<span class="squareb">]</span> <i>name</i><span class="squareb">]</span>
</ul>
</div>

===TAG===
 
<p class="syntaxUL">TAG <span class="term">%screenname</span>:<span class="term">inputname</span> <span class="squareb">[</span><span class="term">attributes</span><span class="squareb">]</span> <span class="squareb">[</span>WITH 'c'<span class="squareb">]</span>
</p>
 
===[[Horizon SOUL interface#Test Receipt statement|Test Receipt]]===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td>{{Template:Test Receipt statement syntax}} </td></tr>
</table>

===TITLE===
 
<p class="syntaxUL">TITLE <span class="squareb">{</span>'<span class="term">text</span>' <span class="squareb">|</span> <span class="term">promptname</span><span class="squareb">}</span>
 <span class="squareb">[</span>AT <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">n</span><span class="squareb">]</span>  <span class="squareb">[</span>TO <span class="squareb">[</span>COLUMN<span class="squareb">]</span> <span class="term">m</span> <span class="squareb">|</span> <span class="squareb">[</span>LEN <span class="term">m</span><span class="squareb">]</span>
 <span class="squareb">[</span>DP <span class="squareb">{</span><span class="term">k</span> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span><span class="squareb">]</span>
 <span class="squareb">[</span>DEFAULT '<span class="term">value</span>'<span class="squareb">]</span>
 <span class="squareb">[</span><span class="squareb">[</span>READ<span class="squareb">]</span> <span class="term">attributes</span><span class="squareb">]</span>  <span class="squareb">[</span>REREAD <span class="term">attributes</span><span class="squareb">]</span>  <span class="squareb">[</span>PRINT <span class="term">attributes</span><span class="squareb">]</span>
</p>
 
===<b id="trace"></b>[[Trace statement|Trace]]===
 
{{Template:Trace statement syntax}}

<p class="note"><b>Note:</b> The output of the <var>Trace</var> statement is controlled by the <var>[[ULTRACE parameter|ULTRACE]]</var> parameter.</p>

===TRANSFER===
 
<p class="syntaxUL">TRANSFER <span class="squareb">[</span>CONTROL<span class="squareb">]</span> TO PROCESS <span class="squareb">{</span><span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
 <span class="squareb">[</span>WITH<span class="squareb">]</span> <span class="squareb">[</span>USERID <span class="squareb">{</span><span class="term">string</span> <span class="squareb">|</span> '<span class="term">%variable</span>'<span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">[</span>PASSWORD <span class="squareb">{</span><span class="term">variable</span> <span class="squareb">|</span> '<span class="term">string</span>'<span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">[</span>ACCOUNT <span class="squareb">{</span><span class="term">%variable</span> <span class="squareb">|</span> '<span class="term">string</span>'<span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">[</span>PASSING <span class="squareb">{</span>IMAGE <span class="term">imagename</span> <span class="squareb">|</span> '<span class="term">string</span>' <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span><span class="squareb">]</span>
</p>

===UPDATE RECORD===
 
<p class="syntaxUL">UPDATE RECORD</p>
 
===VARIABLES ARE===
 
<p class="syntaxUL">VARIABLES ARE
 <span class="squareb">{</span>FIXED <span class="squareb">[</span>DP <span class="term">n</span><span class="squareb">]</span>  <span class="squareb">|</span> FLOAT
 <span class="squareb">|</span> STRING <span class="squareb">[</span>LEN <span class="term">n</span><span class="squareb">]</span>  <span class="squareb">[</span>DP <span class="squareb">{</span><span class="term">n</span> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span>
 <span class="squareb">|</span> UNDEFINED<span class="squareb">}</span>
</p>
 
===Declare <i>%variable</i>===
 
<p class="syntaxUL"><span class="squareb">[</span>DECLARE<span class="squareb">]</span> <span class="term">%variable</span> <span class="squareb">[</span>IS<span class="squareb">]</span>
 <span class="squareb">{</span>FIXED <span class="squareb">[</span>DP <span class="term">n</span><span class="squareb">]</span>  <span class="squareb">|</span> FLOAT<span class="squareb">}</span> <span class="squareb">[</span>ARRAY (<span class="term">d1</span><span class="squareb">[</span>,<span class="term">d2</span><span class="squareb">[</span>,<span class="term">d3</span><span class="squareb">]</span><span class="squareb">]</span>)<span class="squareb">]</span>
 <span class="squareb">[</span>COMMON<span class="squareb">]</span>

<span class="squareb">[</span>DECLARE<span class="squareb">]</span> <span class="term">%variable</span> <span class="squareb">[</span>IS<span class="squareb">]</span>
 STRING <span class="squareb">[</span>LEN <span class="term">n</span><span class="squareb">]</span>  <span class="squareb">[</span>DP <span class="squareb">{</span><span class="term">n</span> <span class="squareb">|</span> *<span class="squareb">}</span><span class="squareb">]</span> <span class="squareb">[</span>ARRAY (<span class="term">d1</span><span class="squareb">[</span>,<span class="term">d2</span>[<span class="term">d3</span><span class="squareb">]</span><span class="squareb">]</span>)<span class="squareb">]</span>
 <span class="squareb">[</span>NO FIELD SAVE<span class="squareb">]</span> <span class="squareb">[</span>COMMON<span class="squareb">]</span>
 <span class="term">%variable</span> <span class="squareb">[</span>(<span class="term">subscript</span>)<span class="squareb">]</span> = <span class="term">expression</span>
</p>

===WAIT===
<table class="noBorder">
<tr><td style="font-family:monoface; padding-right:0px">[[Statement syntax#Notation conventions|(+)]] </td>
<td><p class="syntaxUL">WAIT [<span class="squareb">{</span><span class="term">n</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span> SEC<span class="squareb">[</span>S<span class="squareb">]</span><span class="squareb">]</span> <span class="squareb">[</span>FOR<span class="squareb">]</span>     <br>    <span class="squareb">{</span>ANY RECEIPT RETURN <span class="term">%variable</span>     <br>    <span class="squareb">|</span> RECEIPT <span class="squareb">{</span><span class="term">cid</span> <span class="squareb">|</span> <span class="term">processname</span> <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span><span class="squareb">}</span>
</p></td></tr>
</table>
 
===WRITE===
 
<p class="syntaxUL">WRITE <span class="squareb">[</span>IMAGE<span class="squareb">]</span> <span class="term">imagename</span>
 ON <span class="squareb">{</span><span class="term">seq-filename</span> <span class="squareb">|</span> TERMINAL <span class="squareb">|</span> <span class="term">%variable</span><span class="squareb">}</span>
</p>
 
===WRITE IMAGE===
 
<p class="syntaxUL">WRITE IMAGE <span class="term">imagename</span> ON BUFFER
  <span class="squareb">[</span>POSITION=<span class="term">%pvariable</span> <span class="squareb">|</span> <span class="term">n</span><span class="squareb">]</span>  <span class="squareb">[</span>MAXLEN=<span class="squareb">{</span><span class="term">%lvariable</span> <span class="squareb">|</span> <span class="term">n</span><span class="squareb">}</span><span class="squareb">]</span>
</p>

==Other syntax==

===<b id="tokens"></b>Names, numbers, literals, comments===

<ul>
<li>Names (for example, %variables, labels): see [[Model 204 naming conventions]]
<li>Other constructs: see [[Basic request structure]] (which also discusses some rules for statement labels)
</ul>

===Value specification syntax===
<p>
For all User Language statements and retrieval conditions, wherever the term <var class="term">value</var> appears in the syntax, it can be any of these:</p>
<ul>
<li>Literal number or string </li>
<li><var>VALUE IN</var> clause of the form:
<p class="syntax">VALUE <span class="squareb">[</span>IN<span class="squareb">]</span> <span class="term">label</span>
</p>
</li>
<li>%variable</li>
</ul>
 
===Retrieval condition syntax===
<p>
A <var>Find</var> or <var>For Each Record Where</var> statement can be followed by any number of retrieval conditions separated by an end of line or [[LINEND parameter]] character.</p>
<p>
Conditions can be constructed as follows:      </p>
 
=====Syntax=====
<p class="syntax">[Not] <span class="term">phrase</span> [<span class="squareb">{</span>And <span class="squareb">|</span> Or <span class="squareb">|</span> Nor<span class="squareb">}</span> [Not] <span class="term">phrase</span>] ...
</p>
Where:
<p>
<var class="term">phrase</var> can be constructed as follows:</p>
<ul style="font-family: Consolas,monospace">
<li><i>fieldname</i> = <span class="squareb">[</span>Not<span class="squareb">]</span> <i>value</i> </li>
 
<li><i>fieldname</i> Like <i>pattern</i> </li>
 
<li><i>fieldname</i> Is [Not] <span class="squareb">{</span>Present <span class="squareb">|</span> Like '<i>pattern</i>'<span class="squareb">}</span> </li>
 
<li><i>fieldname</i> Is [Not] <span class="squareb">{</span>[Numerically <span class="squareb">|</span> Alphabetically] <br>
 [Eq <span class="squareb">|</span> = <span class="squareb">|</span> Ne <span class="squareb">|</span> ¬= <span class="squareb">|</span> Greater Than <span class="squareb">|</span> Gt <span class="squareb">|</span> >  <span class="squareb">|</span> Less Than <br><span class="squareb">|</span> Lt <span class="squareb">|</span> < <span class="squareb">|</span> Le <span class="squareb">|</span> <= <span class="squareb">|</span> Ge <span class="squareb">|</span> >= <span class="squareb">|</span> Before <span class="squareb">|</span> After] <i>value</i><span class="squareb">}</span> </li>
 
<li><i>fieldname</i> Is [Not] <span class="squareb">{</span>[Numerically <span class="squareb">|</span> Alphabetically] <br>
 <span class="squareb">{</span>In Range [From <span class="squareb">|</span> After] <i>value1</i> <span class="squareb">{</span>To <span class="squareb">|</span> [And] Before<span class="squareb">}</span> <br>
 <i>value2</i> <span class="squareb">|</span> Between <i>value1</i> And <i>value2</i><span class="squareb">}</span> </li>
 
<li>Files <i>filename</i> </li>
 
<li>Find$ <i>label</i> </li>
 
<li>List$ <i>listname</i> </li>
 
<li>Location <span class="squareb">{</span><i>location</i> <span class="squareb">|</span> =<span class="squareb">}</span> </li>
 
<li>[[#Point$|Point$]] <i>value</i> </li>
 
<li>[[#Sfl$ and Sfge$|Sfge$]] <i>value</i> </li>
 
<li>[[#Sfl$ and Sfge$|Sfl$]] <i>value</i> </li>

<p>
where <i>value</i> can be: </p>
<ul>
<li>A literal number or string</li>

<li><var>Value <span class="squareb">{</span>(<i>[[#Use of expressions|expression]]</i>)</var> | [In] <i>label</i><span class="squareb">}</span>  </li>

<li>A %variable </li>
</ul></ul>
 
<p><b>Notes:</b></p>
<ul>
<li>The first character (<code>¬</code>) of the "not-equal" test (<code>¬=</code>) in the fourth of the items in the list above is the EBCDIC "not sign," which has the hexadecimal value <code>5f</code>.
 
<li>For a description of the pattern in the <var>[Is] Like</var> and <var>Is Not</var> clauses, see the syntax of [[Is Like pattern matching#likeSyntax|Is Like patterns]].
</ul>

====Omitting repeated first words====
<p>
If a sequence of phrases in a particular retrieval condition all have the same first word, that word can be omitted from the latter phrases. For example:</p>
<p class="code">List$ A And Not List$ B
</p>
<p>
can be written:</p>
<p class="code">List$ A And Not B
</p>
<p>
And:</p>
<p class="code">x Is 13 Or x Is Less Than 7
</p>
<p>
can be written:</p>
<p class="code">x Is 13 Or Is Less Than 7
</p>
 
====Omitting duplicated equal signs====
<p>
Duplicated equal signs can be omitted. For example, the expression:</p>
<p class="code">a = 3 Or a = 5 Or a = 40
</p>
<p>
is equivalent to:</p>
<p class="code">a = 3 Or 5 Or 40
</p>
 
====Use of parentheses====
<p>
Parentheses can be placed around any sequence of phrases to clarify the condition or force the evaluation to occur in a particular order. For example:</p>
<p class="code">Not (a = 2 Or List$ y)
a = 1 And (b = 2 OR c = 3)
</p>
 
====Use of expressions====
<p>
[[Using variables and values in computation#Expressions|Expressions]] can be used in <var>Find</var> and <var>For Each Record</var> statements to provide the retrieval condition for the <var>Point$</var>, <var>Sfl$</var>, and <var>Sfge$</var> conditions, as well as for the <var>Eq Value</var> clause: </p>
 
=====Point$=====
<p class="syntax">Point$ Value(<span class="term">expression</span>)
</p>
Where:
<p>
<var class="term">expression</var> is a function call, string concatenation, arithmetic operation, SOUL construct, or Boolean expression. It is preceded by the keyword <var>Value</var>. </p>
<p> 
Example: </p>
<p>
This example finds the first <code>MA</code> record on file, and then counts the number of records from this point in the file:</p>
<p class="code">FD1:
 
IN ICSCUST FPC STATE = MA
     END FIND
FOR 1 RECORD IN FD1
   PRINT 'CURREC = ' WITH $CURREC
   PRINT '>= POINT$'
FD2:
   IN ICSCUST FPC POINT$ VALUE($CURREC)
     END FIND
END FOR
</p>
 
=====Sfl$ and Sfge$=====
<p class="syntax">Sfl$ Value(<span class="term">expression</span>)
</p>
<p>
Or:</p>
<p class="syntax">Sfge$ Value(<span class="term">expression</span>)
</p>
Where:
<p>
<var class="term">expression</var> is a function call, string concatenation, arithmetic operation, SOUL construct, or Boolean expression. It is preceded by the keyword <var>Value</var>. </p>
<p>
Example:
</p>
<p class="code">FOR %CT FROM 1 TO 10
  IN EXPRESS STORE RECORD ($EDITN(%CT,'999'))
    ORD1 = (%REC WITH %CT)
    ORD2 = (%CT * 2)
    ORD4 = (%CT * 4)
  END STORE
END FOR
COMMIT
FOR %CT FROM 1 TO 5
  PRINT 'LESS THAN ' WITH %CT
FD1:
  IN EXPRESS FPC SFL$ VALUE($EDITN(%CT,'999'))
             END FIND
  PRINT 'GREATER THAN OR EQUAL TO ' WITH %CT
FD2:
  IN EXPRESS FPC SFGE$ VALUE($EDITN(%CT,'999'))
             END FIND
END FOR
</p>
 
=====Eq Value=====
<p class="syntax"><span class="term">fieldname</span> Eq Value(<span class="term">expression</span>)
</p>
Where:
<p>
<var class="term">expression</var> is a function call, string concatenation, arithmetic operation, SOUL construct, or Boolean expression. </p>
<p>
Example:
</p>
<p class="code">FD: IN FILE PEOPLE FD
LAST EQ VALUE($READ('LAST NAME?') )
END FIND
</p>

===Print specification syntax===
<p>
A <var>Print</var>, <var>Set</var>, <var>Audit</var>, or <var>Trace</var> statement contains print specifications of the following form:
</p>
<p class="syntax">[<span class="term">term</span>] <span class="squareb">[</span>And <span class="squareb">|</span> Tab <span class="squareb">|</span> With]...[[<span class="term">term</span>] [And <span class="squareb">|</span> Tab <span class="squareb">|</span> With] ...] ... [...]
</p>
Where:
<p>
<var class="term">term</var> can be constructed as follows:</p>
<p class="syntax"><span class="squareb">{</span>'<span class="term">string</span>' <span class="squareb">|</span> <span class="term">%variable</span> <span class="squareb">|</span> Count In <span class="term">label</span> <span class="squareb">|</span> Occurrence In <span class="term">label</span> <span class="squareb">|</span> Value in <span class="label">term</span> <span class="squareb">|</span> <span class="term">function</span><span class="squareb">}</span>
 <span class="squareb">[</span>At <span class="squareb">[</span>Column<span class="squareb">]</span> <span class="term">m</span><span class="squareb">]</span> <span class="squareb">[</span>To <span class="squareb">[</span>Column<span class="squareb">]</span> <span class="term">n</span><span class="squareb">]</span> </p>
<p>
Or, if the statement is within a record loop:
</p>
<p class="syntax"><span class="squareb">{</span><span class="squareb">{</span>Each <span class="squareb">|</span> <span class="n">term</span><span class="squareb">}</span> <span class="term">fieldname</span> <span class="squareb">|</span> *Record <span class="squareb">|</span> *Id<span class="squareb">}</span>
 [At [Column] <span class="term">m</span>] [To [Column] <span class="term">n</span><span class="squareb">}</span>
</p>

<p class="note"><b>Note:</b> For additional <var>Print</var> statement details regarding multiply occurring fields and field groups, see [[Processing multiply occurring fields and field groups#PRINT and PRINT n statements|Print and Print <i>n</i>]] statements for fields. </p>

===Expression syntax===
<p>
The following syntax can be used in: </p>
<ul>
<li>Assignment statements </li>
<li>Conditional <var>If</var> statements and <var>ElseIf</var> clauses
<p>
In the simplified syntax for an <var>If</var> statement, which is:</p>
<p class="syntax">If <span class="term">condition</span> Then <span class="term">statements</span>
</p>
<p>
<var class="term">condition</var> expands to the syntax described in this section. </p></li>

<li>Computed <var>Jump To</var> statements </li>

<li>Subscripts </li>

<li>Function arguments </li>
</ul>
 
=====Syntax=====
<p class="syntax"><span class="squareb">{</span>operand | (expression)<span class="squareb">}</span>  [operator <span class="squareb">{</span>operand <span class="squareb">|</span> (expression)<span class="squareb">}</span>] ...
</p>
Where:
<ul>
<li><var class="term">operand</var> can be constructed as follows:
<p class="syntax">[+ <span class="squareb">|</span> - <span class="squareb">|</span> Not]
 <span class="squareb">{</span>'<span class="term">string</span>' <span class="squareb">|</span> <span class="term">%variable</span> <span class="squareb">|</span> <span class="term">number</span>
 <span class="squareb">|</span> <span class="term">fieldname</span> <span class="squareb">[</span>(subscript)<span class="squareb">]</span> Is <span class="squareb">[</span>Not<span class="squareb">]</span> Present
 <span class="squareb">|</span> Count In <span class="term">label</span> <span class="squareb">|</span> Occurrence In <span class="term">label</span>
 <span class="squareb">|</span> Value In <span class="term">label</span>
 <span class="squareb">|</span> <span class="term">function</span><span class="squareb">}</span>
</p></li>

<li><var class="term">expression</var> (Note: enclosed by parentheses) is a function call, string concatenation, arithmetic operation, SOUL construct, or Boolean expression. For further details, see [[Using variables and values in computation#Expressions|Expressions]]. </li>

<li><var class="term">operator</var> may be one of the following: 
<table style="table-layout: fixed">
<tr>
<td><b>+</b>&nbsp;&nbsp;&nbsp;</td>
<td><b>=</b></td>
<td>EQ</td>
<td>And</td>
</tr>

<tr>
<td><b>-</b></td>
<td><b>¬=</b>&nbsp;&nbsp;&nbsp;</td>
<td>NE&nbsp;&nbsp;</td>
<td>Or</td>
</tr>

<tr>
<td><b>*</b></td>
<td><b>></b></td>
<td>GT</td>
<td>With (Note: this can also be achieved via [[Implicit concatenation]])</td>
</tr>

<tr>
<td><b>/</b></td>
<td><b><</b></td>
<td>LT</td>
<td>Is [Not] Present (Note: applied either to a field or to an [[Methods#optionalParams|optional or default method parameter]])</td>
</tr>

<tr>
<td>&nbsp;</td>
<td><b>>=</b></td>
<td>GE</td>
<td>Is [Not] Like</td>
</tr>

<tr>
<td>&nbsp;</td>
<td><b><=</b></td>
<td>LE</td>
<td></td>
</tr>
</table>
<blockquote class="note"><b>Notes:</b>
<ul>
<li>The first character (<code>¬</code>) of the inequality test above is the EBCDIC "not sign," which has the hexadecimal value <code>5f</code>. </li>

<li>For a description of the <code>Is Like</code> and <code>Is Not</code> clauses, see the syntax of [[Is Like pattern matching|Is Like patterns]]. </li>

<li>For more information about operators, see [[Using variables and values in computation#Operators|Operators]]. </li>
</ul>
</blockquote ></li>
</ul>

===In clause syntax===
<p>
The SOUL statements on this page whose syntax display is preceded by an asterisk (<tt>*</tt>) support an <var>In</var> clause. </p>
<p>
The three basic forms of the <var>In</var> clause are:  </p>
 
<p class="syntax">In [Permanent <span class="squareb">|</span> Temporary ] Group <span class="term">groupname</span>
Member [<span class="term">%member</span> <span class="squareb">|</span> [<span class="term">filename</span> [At <span class="squareb">{</span>location <span class="squareb">|</span> =<span class="squareb">}</span>]]</p>
 
<p class="syntax">In <span class="term">file1</span> [,<span class="term">file2</span>] ...</p>
 
<p class="syntax">In <span class="squareb">{</span>$Curfile <span class="squareb">|</span> $Update<span class="squareb">}</span></p>
<p>
The form <var>In $Curfile</var> can be used only within a record loop.</p>
 
====In Group Member limitations====
<p>
In addition to the three basic forms of the In clause shown above, the <var>In Group Member</var> clause restricts the following statements to one member file in a group context:</p>
<ul>
<li><var>Clear List</var></li>
 
<li><var>Find All Records</var> (and its variants)</li>
 
<li><var>Find All Values</var></li>
 
<li><var>For Record Number</var> (or <var>FRN</var>)</li>
 
<li><var>Store Record</var> </li>
</ul>
<p>
You cannot use an <var>In Group Member</var> clause with a <var>For Each Record</var> statement or with an <var>Add</var>, <var>Change</var>, or <var>Delete Record</var> statement. Only the previously listed statements call accept an <var>In Group Member</var> clause.</p>
 
====Using an In clause in a Begin...End block====
<p>
The file name in the <var>In</var> clause used within a <var>Begin...End</var> block is resolved by the compiler. You can hard-code a file name or use some type of dummy string for the file name. Using a %variable for the file name is not allowed. </p>

===Subscript syntax===
<p>
A subscript has the format:  </p>
 
=====Syntax=====
<p class="syntax">(<span class="term">subscript1</span> [,<span class="term">subscript2</span> [,<span class="term">subscript3</span>]] )
</p>
Where:
<p>
<var class="term">subscript1</var>, <var class="term">subscript2</var>, and <var class="term">subscript3</var> can be any expression. </p>

==Terminal display attributes==
<p>
One or more of the following terminal display attributes can replace the term attribute in a full-screen formatting statement, if the display attribute is supported by the installation:</p>
 
<table>
<caption>List of attributes</caption>
<tr>
<td>BLINK</td>
</tr>
<tr>
<td>BLUE</td>
</tr>
<tr>
<td>BRIGHT</td>
</tr>
<tr>
<td>DIM</td>
</tr>
<tr>
<td>GREEN</td>
</tr>
<tr>
<td>INV[IS[BLE]] </td>
</tr>
<tr>
<td>NOBLINK</td>
</tr>
<tr>
<td>NOREV[ERSE]</td>
</tr>
<tr>
<td>NOU[NDER]SCORE</td>
</tr>
<tr>
<td>PINK</td>
</tr>
<tr>
<td>PROT[ECTED]</td>
</tr>
<tr>
<td>RED</td>
</tr>
<tr>
<td>REV[ERSE]</td>
</tr>
<tr>
<td>TURQUOISE</td>
</tr>
<tr>
<td>[UNDER]SCORE</td>
</tr>
<tr>
<td>UNPROT[ECTED]</td>
</tr>
<tr>
<td>VIS[IBLE]</td>
</tr>
<tr>
<td>WHITE</td>
</tr>
<tr>
<td>YELLOW </td>
</tr>
</table>

==Notation conventions==
<p>
This page uses the following syntax notation conventions: </p>
 
<table>
<tr class="head">
<th>Syntax notation </th>
<th>Indicates that...</th>
</tr>
 
<tr>
<td>Single asterisk (*) </td>
<td>Statements can be preceded by an IN clause, if there is no reference to a previous set (label or list). See [[#IN clause syntax|IN clause syntax]] for more discussion.</td>
</tr>
 
<tr>
<td>Two asterisks (**) </td>
<td>Construct can appear only within a record loop.</td>
</tr>
 
<tr>
<td>Plus sign (+) </td>
<td>Construct requires the optional [[Horizon]] feature.</td>
</tr>
 
<tr>
<td nowrap>Two plus signs (++) </td>
<td>Construct requires the optional User Language to Database 2 feature.</td>
</tr>
 
<tr>
<td>C</td>
<td>The syntax applies to a <var class="product">Model&nbsp;204</var> command as well as a SOUL statement, except any %variable options or clauses.
<p>
<var class="product">Model&nbsp;204</var> commands are listed alphabetically and documented in [[List of Model 204 commands]]. </p></td>
</tr>
 
<tr>
<td>Lowercase italic </td>
<td>Constructs are replaced with variable information.</td>
</tr>
</table>
 
<ul>
<li>A field name (%%) variable can be used anywhere fieldname appears. The %%variable can contain its own subscript, separate from the field name subscript.
<p class="note"><b>Note: </b>
The subscript of an array element must be specified before a field name subscript.</p> </li>
 
<li>The lowercase constructs &mdash; retrieval-conditions, print-specifications, expression, subscript, attribute, and type &mdash; are discussed separately following the syntax summaries, beginning with [[#Value specification syntax|Value specification syntax]].   </li>

<li>For more Model 204 notation conventions, see [[Notation conventions]].</li>
</ul>
 
 
[[Category:SOUL]]