ELowell at 22:14, 12 July 2016

2016-07-12T22:14:27Z

← Older revision		Revision as of 22:14, 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 21:18, 11 July 2016

2016-07-11T21:18:46Z

← Older revision		Revision as of 21:18, 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 IFEFCC call (EXAMINE FIELD CONSTRAINT CONFLICT) returns specific information about field values or record numbers that cause a f..."

2016-07-06T22:04:19Z

Created page with " ==Summary== <dl> <dt>Description</dt> <dd>The IFEFCC call (EXAMINE FIELD CONSTRAINT CONFLICT) returns specific information about field values or record numbers that cause a f..."

New page

==Summary==
<dl>
<dt>Description</dt>
<dd>The IFEFCC call (EXAMINE FIELD CONSTRAINT CONFLICT) returns specific information about field values or record numbers that cause a field constraint conflict using the IFSTOR, IFUPDT, or IFPUT HLI calls.
IFEFCC is similar to the SOUL ON FCC statement and its related $functions.</dd>
<dt>Thread type</dt>
<dd>multiple cursor IFSTRT, single cursor IFSTRT </dd>
<dt>IFCALL function number</dt>
<dd>139</dd>
</dl>

==Syntax==
IFEFCC(RETCODE,FIELDNAME,VALUE,RECNUM,STATEMENT,OLD-VALUE,OLD-RECNUM,FILENAME)
<dl>
<dt>Compile-only form</dt>
<dd>Not available</dd>
<dt>Execute-only syntax</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>RETCODE</td>
<td>[O,i,r] The Model 204 return code is the required output parameter. The code is a binary integer value.
If no field constraint conflict is found, IFEFCC returns an error code of 15.</td>
</tr>
<tr>
<td>FIELDNAM</td>
<td>[O,c,o] The field name is an optional output parameter that returns the name of the field in which the constraint violation occurred. In SOUL this name is available through $UPDFLD. The name is a character string.</td>
</tr>
<tr>
<td>VALUE</td>
<td>[O,c,o] The value is an optional output parameter that returns the field value causing the constraint violation. In SOUL this value is available through $UPDVAL. The value is returned as a character string.</td>
</tr>
<tr>
<td>RECNUM</td>
<td>[O,c,o] The record number is an optional output parameter that returns the internal number of the record whose update causes the conflict. In SOUL this name is available through $UPDREC. This parameter is a character string.</td>
</tr>
<tr>
<td>STATEMENT</td>
<td>[O,c,o] The statement is an optional output parameter that returns the type of update operation causing the conflict. In SOUL it is available through $UPDSTMT.

The possible values are:
<table>
<tr class="head">
<th>Value</th>
<th>Use</th>
</tr>
<tr>
<td>STORE</td>
<td>For IFSTOR call</td>
</tr>
<tr>
<td>ADD</td>
<td>When the field name(*) form is used in the IFUPDT call</td>
</tr>
<tr>
<td>INSERT</td>
<td>When the field name(+<var class="term">n</var>) form is used in the IFUPDT call</td>
</tr>
<tr>
<td>CHANGE</td>
<td>When the field name or field name(<var class="term">n</var>) form is used in the IFUPDT call</td>
</tr>
</table>

This parameter is a character string.
</td>
</tr>
<tr>
<td>OLD-VALUE</td>
<td>[O,c,o] The old value is an optional output parameter that, in the case of an AT-MOST-ONE violation, returns the value of the original field occurrence causing the constraint violation. Otherwise, it returns a blank. In SOUL this value is available through $UPDOVAL. The value is returned as a character string.</td>
</tr>
<tr>
<td>OLD-RECNUM</td>
<td>[O,c,o] The old record number is an optional output parameter that, in the case of a uniqueness violation, returns the internal record number of the record already containing the field=value pair. Otherwise, it returns a -1. In SOUL this name is available through $UNQREC. This parameter is a character string.</td>
</tr>
<tr>
<td>FILENAME</td>
<td>[O,c,o] The file name is an optional output parameter that returns the name of the file in which the constraint violation occurred. In SOUL this name is available through $UPDFILE. The name is a character string.</td>
</tr>
</table>

==Usage notes==

Use the IFEFCC call to determine the exact cause of a field constraint conflict when updating or storing data. Field constraint conflicts are caused when fields within a file violate either the UNIQUE or AT-MOST-ONE Model 204 field-level attribute.

A uniqueness conflict (return code 200) occurs when you try to store a non-unique field value (such as a duplicate telephone number) into a file. An AT-MOST-ONE conflict (return code 202) occurs when you try to store a second occurrence of a field into a record (such as a HEIGHT or EYE_COLOR field).

For more information about uniqueness and AT-MOST-ONE violations, see [[Field design#AT-MOST-ONE, REPEATABLE, and EXACTLY-ONE attributes|AT-MOST-ONE, REPEATABLE, and EXACTLY-ONE attributes]].

==Coding example (COBOL)==
WORKING-STORAGE SECTION.
01 CALL-ARGS.
05 RETCODE PIC 9(5) COMP SYNC.
05 FIELDNAM PIC X(255).
05 VALUE PIC X(255).
05 RECNUM PIC X(11).
05 STATEMENT PIC X(6).
05 OLD-VALUE PIC X(255).
05 OLD-RECNUM PIC X(11).
05 FILENAME PIC X(8) VALUE "FN1;".
.
.
.
PROCEDURE DIVISION.
.
.
.
CALL "IFEFCC" USING RETCODE, FIELDNAM, VALUE, RECNUM, STATEMENT, OLD-VALUE, OLD-RECNUM, FILENAME.

[[Category: HLI functions]]

IFEFCC (HLI function) - Revision history

ELowell at 22:14, 12 July 2016

ELowell at 21:18, 11 July 2016

ELowell: Created page with " ==Summary== Description The IFEFCC call (EXAMINE FIELD CONSTRAINT CONFLICT) returns specific information about field values or record numbers that cause a f..."

ELowell: Created page with " ==Summary==

Description

The IFEFCC call (EXAMINE FIELD CONSTRAINT CONFLICT) returns specific information about field values or record numbers that cause a f..."