View source for IFOPENX (HLI function)


==Summary==
<dl>
<dt>Description</dt>
<dd>The IFOPENX call (OPEN EXCLUSIVE) opens the specified file or group, enqueuing in exclusive mode.</dd>
<dt>Thread type</dt>
<dd>multiple cursor IFSTRT, single cursor IFSTRT</dd>
<dt>IFCALL function number</dt>
<dd>35</dd>
</dl>

==Syntax==
<p class="syntax">IFOPENX|IFOPNX(RETCODE,FILE_SPEC,TIME)</p>

<dl>
<dt>Compile-only form</dt>
<dd>Not available</dd>
<dt>Execute-only form</dt>
<dd>Not available</dd>
</dl>

<p>Specify the parameters in the syntax order shown above. </p>
<table>
<tr class="head">
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>RETCODE</td>
<td>[O,i,r] The Model 204 return code is a required output parameter. The code is a binary integer value.</td>
</tr>
<tr>
<td>FILE_SPEC</td>
<td>[I,c,r] The file specification is a required parameter that specifies the file or group to be opened. Specify a character string. See [[IFOPEN (HLI function)#FILE_SPEC|FILE_SPEC]] for a detailed description of the file specification used for IFOPEN that is also valid for IFOPENX.</td>
</tr>
<tr>
<td>TIME</td>
<td>[I,i,r] The time is a required parameter that specifies the wait time (in seconds). Specify an integer value.</td>
</tr>
</table>

==Usage notes==
<p>Use the IFOPENX call before any data records are accessed to open a file or group. When IFOPENX is called, the named file or group becomes the current file or group. IFOPENX performs the same operations as IFOPEN; however, IFOPENX enqueues on the file in exclusive rather than in share status.</p>
<p>
IFOPENX prevents any other user from accessing the file until the current user closes it. If you issue IFOPENX for a group, all files in the group are enqueued upon in exclusive status and the group itself is enqueued upon in share status. For more information about enqueuing, see [[Transaction back out#Concurrency control and locking mechanisms|Concurrency control and locking mechanisms]].</p>
<p>
If the first attempt to enqueue on a file fails, Model 204 waits the number of seconds specified in the TIME parameter, then it tries again. If the second attempt fails, Model 204 returns a completion code of 3 to the HLI program.</p>

==Coding examples (COBOL)==
<p>
The COBOL coding example below opens a file using the IFOPENX call. The file is called FILEB and requires a password of OURSECRET. (In this example, the group name FILEB does not exist.)</p>
<p class="code">WORKING-STORAGE SECTION.
01  ARGS-FOR-CALL. 
    05 RETCODE      PIC 9(5) COMP SYNC.
    05 FILE-INFO    PIC X(15) VALUE `FILEB;OURSECRET;'.
   05 TIME          PIC 9 COMP SYNC VALUE 3.
.
.
.
PROCEDURE DIVISION.
.
.
.
  CALL "IFOPENX" USING RETCODE, FILE-INFO, TIME.
.
.
.</p>

[[Category: HLI functions]]