Variable-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
ft:locale
en-US
Product name
Syncsort™ MFX
ft:title
Syncsort™ MFX Programmers Guide
Copyright
2024
First publish date
2010
ft:lastEdition
2025-02-20
ft:lastPublication
2025-02-20T09:24:15.574000
Figure 1. Sample Variable-Length Records - Function Definition

The following describes the parameters used in the preceding definition.

exit_status

This parameter points to a variable containing exit status codes. See the exit_status definition for a fixed-length C E15 exit for the code definitions.

record_up

The record_up parameter contains a “universal” pointer to the record being passed to the E15 from the SORTIN. The void* pointer can be cast to point an appropriate structure to describe the record passed to the exit. This allows different record struc­tures, as is common with variable-length records, to share a single pointer definition.

work

The work parameter contains a "universal" pointer to a work area that is to be used to hold an inserted or replaced record returned from the E15. The void* pointer can be cast to point an appropriate structure to describe the work record.

dummy1 - dummy3

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

len_ru

This parameter points to a variable that defines the length of the SORTIN record passed to the E15. This is the length of the record referred to in the record_up parameter.

len_wk

This parameter points to a variable that defines the length of the record to be inserted or used as a replacement for the record_up record. This is the length of the record referred to in the work parameter. This field must be set by the exit when an insert or replace operation is performed.

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.