ELowell at 22:08, 12 July 2016

2016-07-12T22:08:36Z

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

2016-07-11T21:10:46Z

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

2016-07-05T23:18:14Z

Created page with " ==Summary== <dl> <dt>Description</dt> <dd>The IFCTO 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 IFCTO 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.</dd>
<dt>Thread type</dt>
<dd>single cursor IFSTRT thread</dd>
<dt>IFCALL function number</dt>
<dd>65</dd>
</dl>

==Syntax==
IFCTO(RETCODE,BUFFER,FIELD_LIST,CTO_NAME,%VARBUF,%VARSPEC)
<dl>
<dt>Compile-only form</dt>
<dd>IFCALL function number: 66
IFCTOC(RETCODE,FIELD_LIST,CTO_NAME)</dd>
<dt>Execute-only form</dt>
<dd>IFCALL function number: 67
IFCTOE(RETCODE,BUFFER,CTO_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 IFCTO for each field that is defined by the FIELD_LIST parameter, described below. 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 current record. If a specified field does not occur in the record, its counter is set to zero.
</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>CTO_NAME</td>
<td>[I,s,o/r] The name of the IFCTO compilation is a required input parameter with IFCTOC and optional with IFCTO or IFCTOE. If specified, Model 204 saves the compilation using this name. Specify the name as unique and as a short character string (maximum 32 characters).
Any characters except the following are valid in the name: blank, comma, parenthesis, equal sign, or semicolon. The first character in the name must be alphanumeric. A null value is equivalent to omitting the name parameter. 
</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#Declaring %variables and %variable arrays|Declaring %variables and %variable arrays]].
</td>
</tr>
<tr>
<td nowrap>%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 IFCTO call to count occurrences of fields in the current record. Issue the IFCTO call after a current record is selected by IFGET, IFPOINT, or IFBREC. The record is enqueued with share status. 

IFCTO is available for use only on a single cursor IFSTRT thread. IFCTO operates similarly to the [[IFOCC (HLI function)|IFOCC call]] that is used with multiple cursor IFSTRT.

The IFCTO call is the equivalent of the SOUL [[Processing multiply occurring fields and field groups#COUNT OCCURRENCES OF statement|COUNT OCCURRENCES OF statement]] in the host language environment.

==Coding example (PL/1)==
DCL ERROR FIXED BIN (31),
BUFFER CHAR (8)
FIELDS CHAR (20) VARYING INITIAL ('CAR,CHILD NAME');
.
.
.
CALL IFCTO (ERROR,BUFFER,FIELDS)

<blockquote class="note">Note: After the IFCTO call shown above is issued to count the number of field occurrences in a record that contains two cars and five children, BUFFER contains the following hexadecimal value:
0000000200000005</blockquote>

[[Category: HLI functions]]

IFCTO (HLI function) - Revision history

ELowell at 22:08, 12 July 2016

ELowell at 21:10, 11 July 2016

ELowell: Created page with " ==Summary== Description The IFCTO 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 IFCTO call (COUNT OCCURRENCES) counts the number of occurrences of the specified field, or fields, in the current record and ret..."