ELowell at 23:01, 12 July 2016

2016-07-12T23:01:42Z

← Older revision		Revision as of 23:01, 12 July 2016
Line 1:		Line 1:
	The conventions used on this page are described in [[HLI: Function ~~call list~~#Function call notation conventions\|Function call notation conventions]].		The conventions used on this page are described in [[HLI: Function summary#Function call notation conventions\|Function call notation conventions]].

	==Summary==		==Summary==

ELowell at 22:07, 11 July 2016

2016-07-11T22:07:58Z

← Older revision		Revision as of 22:07, 11 July 2016
Line 1:		Line 1:
			The conventions used on this page are described in [[HLI: Function call list#Function call notation conventions\|Function call notation conventions]].

	==Summary==		==Summary==

ELowell: Created page with " ==Summary==

Description

The IFFWOL call (FIND WITHOUT LOCKS) selects records from a Model 204 file or group without obtaining record locks and creates a fou..."

2016-07-07T20:08:42Z

Created page with " ==Summary== <dl> <dt>Description</dt> <dd>The IFFWOL call (FIND WITHOUT LOCKS) selects records from a Model 204 file or group without obtaining record locks and creates a fou..."

New page

==Summary==
<dl>
<dt>Description</dt>
<dd>The IFFWOL call (FIND WITHOUT LOCKS) selects records from a Model 204 file or group without obtaining record locks and creates a found set.</dd>
<dt>Thread type</dt>
<dd>multiple cursor IFSTRT, single cursor IFSTRT</dd>
<dt>IFCALL function number</dt>
<dd>87</dd>
</dl>

==Syntax==
IFFWOL|IFFWO(RETCODE,FIND_SPEC,FWOL_NAME,%VARBUF,%VARSPEC)
<dl>
<dt>Compile-only form</dt>
<dd>IFCALL function number: 88
IFFWOLC|IFFWOC(RETCODE,FIND_SPEC,FWOL_NAME)</dd>
<dt>Execute-only form</dt>
<dd> IFCALL function number: 89
IFFWOLE|IFFWOE(RETCODE,FWOL_NAME,%VARBUF,%VARSPEC)</dd>
</dl>

Specify the parameters in the syntax order shown above.
<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 the required first parameter. The code is a binary integer value.</td>
</tr>
<tr>
<td>FIND_SPEC</td>
<td>[I,c,r] The find specification is a required input parameter that is the selection criteria to be used for retrieving records. Specify the selection criteria as a character string.

See [[IFFIND (HLI function)#FIND_SPEC|FIND_SPEC]] for a detailed description of the find specification used for IFFIND that is also valid for IFFWOL. 
</td>
</tr>
<tr>
<td>FWOL_NAME</td>
<td>[I,s,r/o] The name of the IFFWOL compilation is an input parameter that is required for use with a multiple cursor IFSTRT thread. It is only required for a single cursor IFSTRT thread if using the Compiled IFAM facility (IFFWOLC and IFFWOLE). Model 204 saves the compilation using this name.

Specify the name as unique and as a short character string (maximum 32 characters).
<ul>
<li>On a single cursor IFSTRT thread, any characters except the following are valid in the name: blank, comma, parenthesis, equal sign, or semicolon.</li>
<li>On a multiple cursor IFSTRT thread, the first character in the name must be alphanumeric, and the name must begin with a letter (A-Z or a-z) which may be followed by a letter, a digit (0-9), a period (.), or underscore (_).</li>
</ul>

Note: A null value is equivalent to omitting the name parameter and is not valid for a multiple cursor thread.
</td>
</tr>
<tr>
<td>%VARBUF</td>
<td>[I,c,o] The variable buffer is an optional input parameter that addresses a data area, which accommodates up to 255 bytes of data per value. The buffer contains values that are defined by the %VARSPEC parameter, below, to be assigned to %variables. Specify a character string. For information about %variables, see [[Using variables and values in computation]].</td>
</tr>
<tr>
<td>%VARSPEC</td>
<td>[I,c,o] The variable specification describes the format of the data that is contained in the %VARBUF parameter and lists the %variables to be assigned. %VARSPEC specifies the contents of the variable buffer, described above. Specify a character string which follows a LIST, DATA, or EDIT syntax.

%VARSPEC is a required input parameter if %VARBUF is specified.
</td>
</tr>
</table>

==Usage notes==

Use the IFFWOL call to retrieve records without locks. The find specification is based on a specified combination of retrieval conditions and is identical to the one that is used with the IFFIND call.

==Completion return code (RETCODE)==

A completion code of 4 indicates an IFFWOL error. If the IFFWOL call is unsuccessful, Model 204 returns a completion code of 4 for the following error conditions: 
<ul>
<li>An error in an IFFWOL specification. Note that Model 204 does not save the compilation and does not define the compilation name.</li>
<li>A field name variable is replaced by a non-existent field. In this case, Model 204 does not execute the IFFWOL, but it does save the compilation if the name parameter is specified. </li>
<li>An error is encountered in a %variable parameter.</li>
</ul>

==Coding example (COBOL)==
WORKING-STORAGE SECTION.
01 CALL-ARGS.
05 RETCODE PIC 9(5) COMP SYNC.
05 QUAL-1 PIC X(75) VALUE 'SEX=FEMALE;
OCCUPATION=DOCTOR OR DENTIST;
CITY=BOSTON;NAME LIKE "PAT*";END;'.
.
.
.
PROCEDURE DIVISION.
.
.
.
CALL "IFFWOL" USING RETCODE, QUAL-1.

[[Category: HLI functions]]

IFFWOL (HLI function) - Revision history

ELowell at 23:01, 12 July 2016

ELowell at 22:07, 11 July 2016

ELowell: Created page with " ==Summary== Description The IFFWOL call (FIND WITHOUT LOCKS) selects records from a Model 204 file or group without obtaining record locks and creates a fou..."

ELowell: Created page with " ==Summary==

Description

The IFFWOL call (FIND WITHOUT LOCKS) selects records from a Model 204 file or group without obtaining record locks and creates a fou..."