View source for IFCALL (HLI function)


==Summary==
<dl>
<dt>Description</dt>
<dd>The IFCALL call (CALL) issues a call to a Host Language Interface function by number.</dd> 
<dt>Thread type</dt>
<dd>multiple cursor IFSTRT, single cursor IFSTRT</dd>
<dt>IFCALL function number</dt>
<dd>Not applicable</dd>
</dl>

==Syntax==
<p class="syntax">IFCALL(FUNC_NO,RETCODE,PARM_LIST)</p>
<dl>
<dt>Compile-only form</dt>
<dd>Not available</dd>
<dt>Execute-only form</dt>
<dd>Not available</dd>
</dl>

Specify the parameters in the syntax order shown above.
<table>
<tr class="head">
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>FUNC_NO</td>
<td>[I,i,r] The function number is the required first parameter (input) that specifies the preassigned number of a particular HLI call to be run. Specify the function number as an integer value using one of the values listed in [[#HLI func nums|Host Language Interface function numbers]]. You can specify one number per call.</td>
</tr>
<tr>
<td>RETCODE</td>
<td>[O,i,r] The Model 204 return code is a required output parameter. Model 204 returns a completion code for the call whose function number is specified. The code is a binary integer value.</td>
</tr>
<tr>
<td>PARM_LIST</td>
<td>[I,c,r] The parameter list is a required input parameter that specifies the parameter(s) required by the call (excluding return code) whose function number is specified. Specify a character string using the following format:
<p class="syntax"><span class="term">parm1</span> [,<span class="term">parm2</span>...];</p>
<p>
See the parameter description, excluding the return code, for the call whose number is specified. </p>
</td>
</tr>
</table>

==Usage notes==
<p>
The IFCALL call is not valid on an IFAM1 type of IFSTRT thread, or on an IFDIAL thread. The form and action of the IFCALL call are no different on a multiple cursor or single cursor IFSTRT thread.</p>
<p>
You can use IFCALL to call by number any Host Language Interface call that is assigned a number in the following table. Note that IFCALL does not have its own function number. There are also no function numbers for IFSTRT (in IFAM1) and IFLOG. </p>
<p>
Function numbers are only available for use with IFCALL. IFCALL provides an alternative for coding calls where the host language limits the name variable length. </p>
<div id="HLI func nums"></div>
<table>
<p class="caption">Host Language Interface function numbers</p>
<tr class="head">
<th>Number-call name</th>
<th>Number-call name</th>
<th>Number-call name</th>
</tr>
<tr>
<td> 0 - reserved</td>
<td>47 - IFFINDE | IFFDE</td>
<td> 94 - reserved</td>
</tr>
<tr>
<td> 1 - IFSTRT (in IFAM2 and IFAM4)</td>
<td>48 - IFGETC</td>
<td> 95 - IFOCUR</td>
</tr>
<tr>
<td> 2 - IFSTHRD | IFSTRD</td>
<td>49 - IFGETE</td>
<td> 96 - IFCSA</td>
</tr>
<tr>
<td> 3 - IFFNSH</td>
<td>50 - IFGETXE | IFGTXE</td>
<td> 97 - IFABXIT</td>
</tr>
<tr>
<td> 4 - IFSTRTN | IFSTRN</td>
<td>51 - IFMOREC | IFMREC</td>
<td> 98 - IFFTCH</td>
</tr>
<tr>
<td> 5 - reserved</td>
<td>52 - IFMOREE | IFMREE</td>
<td> 99 - IFFTCHC | IFFCHC</td>
</tr>
<tr>
<td> 6 - IFDIAL</td>
<td>53 - IFMORXE | IFMRXE</td>
<td>100 - IFFTCHE | IFFCHE</td>
</tr>
<tr>
<td> 7 - IFDIALN | IFDILN</td>
<td>54 - IFPUTC</td>
<td>101 - reserved</td>
</tr>
<tr>
<td> 8 - IFHNGUP | IFHNGP</td>
<td>55 - IFPUTE</td>
<td>102 - reserved</td>
</tr>
<tr>
<td> 9 - IFREAD</td>
<td>56 - IFFNDX | IFFD</td>
<td>103 - IFRELR</td>
</tr>
<tr>
<td>10 - IFWRITE | IFWRIT</td>
<td>57 - IFFNDXC | IFFDXC</td>
<td>104 - IFRELA</td>
</tr>
<tr>
<td>11 - IFOPEN</td>
<td>58 - IFFNDXE | IFFDXE</td>
<td>105 - IFCMTR</td>
</tr>
<tr>
<td>12 - IFCLOSE | IFCLOS</td>
<td>59 - IFRFLD</td>
<td>106 - IFOCURC | IFOCRC</td>
</tr>
<tr>
<td>13 - IFFIND | IFFD</td>
<td>60 - IFDISP</td>
<td>107 - IFOCURE | IFOCRE</td>
</tr>
<tr>
<td>14 - IFCOUNT | IFCNT</td>
<td>61 - IFFLS</td>
<td>108 - IFCLST</td>
</tr>
<tr>
<td>15 - IFGET</td>
<td>62 - IFDELF</td>
<td>109 - IFPROLS | IFPRLS</td>
</tr>
<tr>
<td>16 - IFMORE</td>
<td>63 - IFNFLD</td>
<td>110 - IFRRFLS | IFRFLS</td>
</tr>
<tr>
<td>17 - IFLIST</td>
<td>64 - IFUTBL</td>
<td>111 - reserved</td>
</tr>
<tr>
<td>18 - IFPUT</td>
<td>65 - IFCTO</td>
<td>112 - IFSTOR</td>
</tr>
<tr>
<td>19 - IFDREC</td>
<td>66 - IFCTOC</td>
<td>113 - IFSTRC</td>
</tr>
<tr>
<td>20 - IFBREC</td>
<td>67 - IFCTOE</td>
<td>114 - IFSTRE</td>
</tr>
<tr>
<td>21 - IFDSET</td>
<td>68 - IFSORT</td>
<td>115 - IFUPDT</td>
</tr>
<tr>
<td>22 - IFFILE</td>
<td>69 - IFSRTC</td>
<td>116 - IFUPDTC | IFUPDC</td>
</tr>
<tr>
<td>23 - IFINIT</td>
<td>70 - IFSRTE</td>
<td>117 - IFUPDTE | IFUPDE</td>
</tr>
<tr>
<td>24 - IFDFLD</td>
<td>71 - IFBOUT</td>
<td>118 - IFFRN</td>
</tr>
<tr>
<td>25 - IFEPRM</td>
<td>72 - IFCMMT</td>
<td>119 - IFFRNC</td>
</tr>
<tr>
<td>26 - IFSPRM</td>
<td>73 - IFDALL</td>
<td>120 - IFFRNE</td>
</tr>
<tr>
<td>27 - IFRPRM</td>
<td>74 - IFFDV</td>
<td>121 - IFRNUM</td>
</tr>
<tr>
<td>28 - IFERR</td>
<td>75 - IFFDVC</td>
<td>122 - IFOCC</td>
</tr>
<tr>
<td>29 - IFGERR</td>
<td>76 - IFFDVE</td>
<td>123 - IFOCCC</td>
</tr>
<tr>
<td>30 - IFCHKPT | IFCHKP</td>
<td>77 - IFGETV </td>
<td>124 - IFOCCE</td>
</tr>
<tr>
<td>31 - reserved</td>
<td>78 - IFGTVC</td>
<td>125 - IFCCUR</td>
</tr>
<tr>
<td>32 - IFDVAL</td>
<td>79 - IFGTVE</td>
<td>126 - IFFAC</td>
</tr>
<tr>
<td>33 - IFPROL </td>
<td>80 - IFSRTV </td>
<td>127 - IFFACC</td>
</tr>
<tr>
<td>34 - IFRRFL</td>
<td>81 - IFSTVC</td>
<td>128 - IFFACE</td>
</tr>
<tr>
<td>35 - IFOPENX | IFOPNX</td>
<td>82 - IFSTVE </td>
<td>129 - reserved</td>
</tr>
<tr>
<td>36 - IFGETX</td>
<td>83 - IFSKEY</td>
<td>130 - reserved</td>
</tr>
<tr>
<td>37 - IFMOREX | IFMREX</td>
<td>84 - IFSKYC</td>
<td>131 - reserved</td>
</tr>
<tr>
<td>38 - IFDEQ</td>
<td>85 - IFSKYE </td>
<td>132 - reserved</td>
</tr>
<tr>
<td>39 - IFENQ</td>
<td>86 - IFSETUP | IFSETP</td>
<td>133 - reserved</td>
</tr>
<tr>
<td>40 - IFENQL</td>
<td>87 - IFFWOL | IFFWO</td>
<td>134 - reserved</td>
</tr>
<tr>
<td>41 - IFDEQL</td>
<td>88 - IFFWOLC | IFFWOC</td>
<td>135 - reserved</td>
</tr>
<tr>
<td>42 - IFDTHRD | IFDTRD</td>
<td>89 - IFFWOLE | IFFWOE</td>
<td>136 - reserved</td>
</tr>
<tr>
<td>43 - IFATTN</td>
<td>90 - reserved</td>
<td>137 - reserved</td>
</tr>
<tr>
<td>44 - IFPOINT | IFPNT</td>
<td>91 - reserved</td>
<td>138 - IFERLC</td>
</tr>
<tr>
<td>45 - IFFLUSH | IFFLSH</td>
<td>92 - reserved</td>
<td>139 - IFEFCC</td>
</tr>
<tr>
<td>46 - IFFINDC | IFFDC</td>
<td>93 - reserved</td>
<td>&nbsp;</td>
</tr>
</table>

==Coding example (COBOL)==
<p class="code">WORKING-STORAGE SECTION.
01  ARGS-FOR-CALL. 
    05  FUNC-NUM  PIC 9(5) VALUE 14.
    05  RETCODE   PIC 9(5) COMP SYNC.
    05  COUNT     PIC 9(5).
.
.
.
PROCEDURE DIVISION.
.
.
.
  CALL "IFCALL" USING FUNC-NUM, RETCODE, COUNT.</p>
<p>
In this example, IFCALL calls function number 14, IFCOUNT, which requires a single parameter for the output parameter, called COUNT.</p>

[[Category: HLI functions]]