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
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. 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 E35 exit for the code definitions.

record_up

The record_up parameter contains a “universal” pointer to the record leaving Phase 3. The void* pointer can be cast to point an appropriate structure to describe the record passed to the exit. This allows different record structures, as is common with variable-length records, to share a universal pointer.

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 E35. The void* pointer can be cast to point an appropriate structure to describe the work record.

in_buf

The in_buf parameter contains a "universal" 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. The void* pointer can be cast to point an appropriate structure to describe the work record.

dummy1

This parameter defines an unused place holder.

len_ru

This parameter points to a variable that defines the length of the record leaving Phase 3. 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.

len_ib

This parameter points to a variable that defines the length of the record that MFX is to put in the output data set. This is the length of the record referred to in the in_buf parameter.

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.