ELowell at 23:07, 12 July 2016

2016-07-12T23:07:23Z

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

2016-07-11T22:14:35Z

← Older revision		Revision as of 22:14, 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 IFOCC call (COUNT OCCURRENCES) counts the number of occurrences of the specified field, or fields, in the current record and ret..."

2016-07-07T22:55:59Z

Created page with " ==Summary== <dl> <dt>Description</dt> <dd>The IFOCC call (COUNT OCCURRENCES) counts the number of occurrences of the specified field, or fields, in the current record and ret..."

New page

==Summary==
<dl>
<dt>Description</dt>
<dd>The IFOCC call (COUNT OCCURRENCES) counts the number of occurrences of the specified field, or fields, in the current record and returns a count value for each field in an output parameter. IFOCC specifies the cursor for the current record.</dd>
<dt>Thread type</dt>
<dd>multiple cursor IFSTRT</dd>
<dt>IFCALL function number</dt>
<dd>122</dd>
</dl>

==Syntax==
IFOCC(RETCODE,BUFFER,CURSOR_NAME,FIELD_LIST,OCC_NAME,%VARBUF,%VARSPEC)

<dl>
<dt>Compile-only form</dt>
<dd>IFCALL function number: 123
IFOCCC(RETCODE,CURSOR_NAME,FIELD_LIST,OCC_NAME)</dd>
<dt>Execute-only form</dt>
<dd> IFCALL function number: 124
IFOCCE(RETCODE,BUFFER,OCC_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>BUFFER</td>
<td>[O,c,r] The buffer location is a required output parameter that specifies the address of the user's data area. Specify a character string. The buffer contains the occurrence counter, or counters, returned by IFOCC for each field that is defined by the FIELD_LIST parameter described in this table. For each field specified, a four-byte value is returned.

Multiple count values are positioned in order corresponding to the location of the fields in the field list. If a specified field does not occur in the record, its counter is set to zero.
</td>
</tr>
<tr>
<td>CURSOR_NAME</td>
<td>[I,c,r] Is a required input parameter that specifies the name of the cursor pointing to the current record for which the field count(s) is (are) performed. This is a character string, the name previously assigned to the cursor in a corresponding [[IFOCUR (HLI function)|IFOCUR]] call.
</td>
</tr>
<tr>
<td>FIELD_LIST</td>
<td>[I,c,r] The field specification is a required input parameter that defines the field, or fields, that are to be counted in the current record. Specify the name of a field as a character string. You must list at least one field to be counted in the current record. You can list additional fields by separating field names with a comma.</td>
</tr>
<tr>
<td>OCC_NAME</td>
<td>[I,s,o] The name of the IFOCC compilation is an optional input parameter. If OCC_NAME is specified, Model 204 saves the compilation using the name.


Specify the name as unique and as a short character string (maximum 32 characters). 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 (_). A null value is equivalent to omitting the name parameter and is not valid. 
</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 %variable parameter, and it lists the %variables to be assigned. %VARSPEC specifies the contents of the variable buffer, described above. Specify a character string that follows a LIST, DATA, or EDIT syntax.

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

==Usage notes==

Use the IFOCC call to count occurrences of fields in a record. 

IFOCC requires a cursor to specify the current record, but otherwise it operates similarly to the single cursor [[IFCTO (HLI function)|IFCTO]] call.

The IFOCC call is the equivalent of the COUNT OCCURRENCES statement in SOUL in the host language multiple cursor environment. For information about the COUNT OCCURRENCES statement, see [[Operations on multiply occurring fields]].

==Coding example (COBOL)==
WORKING-STORAGE SECTION.
01 CALL-ARGS.
05 RETCODE PIC 9(5) COMP SYNC.
05 BUFFER PIC X(8).
05 CURSOR-NAME PIC X(5) VALUE "CUR1;".
05 FIELD-LIST PIC X(12) VALUE "COLOR, MAKE;".
.
.
.
PROCEDURE DIVISION.
.
.
.
CALL "IFOCC" USING RETCODE, BUFFER, CURSOR-NAME,
FIELD-LIST.

[[Category: HLI functions]]

IFOCC (HLI function) - Revision history

ELowell at 23:07, 12 July 2016

ELowell at 22:14, 11 July 2016

ELowell: Created page with " ==Summary== Description The IFOCC call (COUNT OCCURRENCES) counts the number of occurrences of the specified field, or fields, in the current record and ret..."

ELowell: Created page with " ==Summary==

Description

The IFOCC call (COUNT OCCURRENCES) counts the number of occurrences of the specified field, or fields, in the current record and ret..."