Return Codes - 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

0

Accept this record. This instructs MFX to accept the record now leaving Phase 3. Place the (work area) address of this record in Register 1. Exits using the 32-bit parameter list return a 31-bit address; exits using the 64-bit parameter list return a 64-bit address. This return code is used when selectively editing records for output; it passes the (possibly altered) record back to the sort. The RECORD statement is required if this exit routine changes the maximum record length.         

4

Delete this record. MFX will delete the record leaving Phase 3. There is no need to load the address of this record into Register 1. When MFX returns control to the E35, the first word of the parameter list (the address of the record leaving Phase 3) will refer to a new record, but the second word (the address of the output area record) will be unchanged.

8

Disconnect E35. This instructs MFX to process any remaining records without showing them to the E35 exit. Register 1 is ignored for processing this return code. When this return code is used at end-of file (signalled by a zero address in the first word of the parameter list), it indicates that E35 is also finished and will not add additional records. When used before end-of-file, it indicates that MFX should process the "current" record passed to the E35, and any subsequent records, as if there were no E35 present. Note that when MFX is not creating any output files (SORTOUT or SORTOFxx) and E35 is the only "output", MFX terminates immediately, since any subsequent records will never be seen. Note that if an XSUM or XDUP data set was being created, it will only contain records generated prior to the return code of 8.

12

Insert a record. This tells MFX to add a record just before the record is about to leave Phase 3. Load the address of the inserted record into Register 1. Exits using the 32-bit parameter list return a 31-bit address; exits using the 64-bit parameter list return a 64-bit address. When MFX returns control to the E35 exit routine, the first word of the parameter list (the address of the record leaving Phase 3) will be unchanged, but the second word (the address of the output area record) will refer to the inserted record. The exit routine can then add another record or process the current one.

16

Terminate MFX. This tells MFX to end its program and return to the calling program or the supervisor. MFX uses a completion code of 16 to indicate that the sort was unsuccessful.