Fixed-Length Records - Function Definition - mfx - 3.1

Syncsort™ MFX Programmers Guide
Product type
Software
Portfolio
Integrate
Product family
Syncsort™ Software
Product
Syncsort™ MFX > MFX
Version
3.1
Language
English
Content type
Programmer’s Guide
Product name
Syncsort™ MFX
Title
Syncsort™ MFX Programmers Guide
Copyright
2024
First publish date
2010
Last updated
2024-11-06
Published on
2024-11-06T17:38:26.716054
Figure 1. Fixed-Length Records - Function Definition

The following describes the parameters used in the preceding definition.

exit_status

This parameter points to a variable containing one of the fol­lowing exit status codes:

00 First record. MFX uses this Code to indicate the first call to the C exit and that the first record to leave Phase 3 is in the record_up area. If there are no records to pass to the exit, a 08 status will be passed to the exit on the first call.

04

Most records. This is used for all calls except the first one when there are records in the record_up area. After Code 00 has been issued, Code 04 is passed to the exit until there is no record for the sort to pass to the record_up area.

08

All records passed. This indicates that the last record has already been processed by the exit. Do not attempt to reference the record again. No more records will be passed to the exit routine. Note that if MFX is not passing any records to Phase 3, 08 will be passed every time including the first time.

record_up

The record_up parameter contains a pointer to the record leaving Phase 3. The struct_ru data type represents a structure that describes the fields within the record.

work

The work parameter contains a pointer to a work area that is to be used to hold an inserted or replaced record returned from the E35. The struct_ins_rep data type represents a structure that describes the fields within the inserted or replaced record.

in_buf

The in_buf parameter contains a pointer to the record that MFX is to put in the output data set. Until a record has been accepted or inserted, this pointer will be null. A record at this address can be modified if required.

dummy1 - dummy4

These parameters define unused place holders. They are used with variable-length C E35 communication. Their definition here allows a common parameter list for fixed and variable-length C E15 and E35 exits.

comm_len

This parameter points to a variable that defines the communication area length.

communication_area

The communication_area parameter contains a pointer to the communication area. The struct_ca data type represents a structure that describes the fields in the communication area.