IFDALL (HLI function)

From m204wiki
Jump to navigation Jump to search

The conventions used on this page are described in Function call notation conventions.

Summary

Description
The IFDALL call (DELETE ALL) deletes all occurrences of a specified Model 204 field from the current record.
Thread type
multiple cursor IFSTRT, single cursor IFSTRT
IFCALL function number
73

Syntax

IFDALL(RETCODE,FIELD_NAME,CURSOR_NAME)

Compile-only form
Not available
Execute-only form
Not available

Specify the parameters in the syntax order shown above.

Parameter Description
RETCODE [O,i,r] The Model 204 return code is the required first parameter. The code is a binary integer value.
FIELD_NAME [I,c,r] The field name is a required input parameter that specifies the name of the Model 204 field to be deleted. You can specify only one field to be deleted per call. Specify a character string variable.
CURSOR_NAME [I,s,r] The name of the cursor is an input parameter that is available only for use with a multiple cursor IFSTRT thread and is required for specifying the current record from which the field will be deleted. Specify the cursor name as a short character string, using the name previously assigned to the cursor in a corresponding IFOCUR call.

Note: The cursor name is not a valid parameter for use with a single cursor IFSTRT thread.

Usage notes

You can issue the IFDALL call only when a current record exists. The IFDALL call is valid on all types of IFSTRT threads. On a single cursor IFSTRT thread, issue the IFDALL call for the current record after using an IFBREC, IFPOINT, or IFGET call.

When FOPT=X'10' and the date/time stamp feature is installed, the IFDALL function is not supported for DTS files.

On a multiple cursor IFSTRT thread, you must specify the cursor for the current record. The cursor that is specified must have a current record from a previous IFSTOR, IFFRN, or IFFTCH call.

Use the IFDALL call to delete a Model 204 field except for a field that has been defined as having one of the following attributes:

  • INVISIBLE attribute
  • Sort key
  • Hash key

Note: You cannot use IFDALL on a sorted record set.

Coding example (COBOL)

WORKING-STORAGE SECTION. 01 CALL-ARGS. 05 RETCODE PIC 9(5) COMP SYNC. 05 DELETE-FIELD-NAME PIC X(4) VALUE "VIN;". . . . PROCEDURE DIVISION. . . . CALL "IFDALL" USING RETCODE, DELETE-FIELD-NAME.