EDGXSF mapping

Always use macro EDGXSF to determine the exact labels used to define the DFSMSrmm structured field introducers. The tables in this topic show the dummy control section and the data types that define the generic mapping for the structured field introducers defined in Structured field introducers (SFIs).

    Common Name:          API Structure Field Introducers
    Macro ID:             EDGXSF
    DSECT Name:           XSF_SFI
    Owning Component:     DFSMSrmm (DF186)
    Eye-Catcher ID:       None
    Storage Attributes:   Subpool: user specified
                          Key: any key
                          Residency: 31 bit
    Size:                 Variable
    Created by:           Caller
    Pointed to by:        N/A
    Serialization:        None
    Function:             The XSF_SFI area is initialized by
                          DFSMSrmm when an API call is made
                          via the EDGXCI executable macro

Table 1. Structure XSF_OUTBUF
`Offset`	`Offset`
`Dec`	`Hex`	`Type`	`Len`	`Name(Dim)`	`Description`
`0`	`(0)`	`STRUCTURE`	`*`	`XSF_OUTBUF`	`Output buffer`
`0`	`(0)`	`SIGNED`	`4`	`XSF_OUTBUF_BUFLNG`	`Output buffer length`
`4`	`(4)`	`SIGNED`	`4`	`XSF_OUTBUF_RQDLNG`	`Required buffer length`
`8`	`(8)`	`SIGNED`	`4`	`XSF_OUTBUF_DATALNG`	`Length of output data`
`12`	`(C)`	`CHARACTER`	`*`	`XSF_OUTBUF_FIELDS`	`Start of structured fields`
`Structured Field Introducers for Structured Fields`
`0`	`(0)`	`STRUCTURE`	`*`	`XSF_SFI`	`Structured field introducers`
`0`	`(0)`	`CHARACTER`	`8`	`XSF_SFI_HD`
`0`	`(0)`	`SIGNED`	`2`	`XSF_SFI_LENGTH`	`Length`
`2`	`(2)`	`CHARACTER`	`3`	`XSF_SFI_ID`	`Identifier`
`2`	`(2)`	`CHARACTER`	`2`	`XSF_SFI_IDVAL`	`Identifier value`
`4`	`(4)`	`CHARACTER`	`1`	`XSF_SFI_IDQUAL`	`Identifier qualifier`
`5`	`(5)`	`UNSIGNED`	`1`	`XSF_SFI_TYPE`	`Type`
`7`	`(7)`	`UNSIGNED`	`1`	`XSF_SFI_DTYPE`	`Data type`
`8`	`(8)`	`CHARACTER`	`*`	`XSF_SFI_DATA`	`Start of data`
`Compound SFI definition`
`8`	`(8)`	`STRUCTURE`	`14`	`XSF_SFI_COMPTYPE1`	`Compound section`
`8`	`(8)`	`CHARACTER`	`6`	`XSF_SFI_COMPDATA`
`8`	`(8)`	`CHARACTER`	`6`	`XSF_SFI_COMPHDR`	`Compound header`
`8`	`(8)`	`CHARACTER`	`6`	`XSF_SFI_COMPENT`	`Compound entry`
`8`	`(8)`	`UNSIGNED`	`1`	`XSF_SFI_COMPTYPE`	`Compound type`
`9`	`(9)`	`CHARACTER`	`3`	`XSF_SFI_FIELD1`
`9`	`(9)`	`UNSIGNED`	`1`	`XSF_SFI_LEN1`	`Length of first field`
`10`	`(A)`	`UNSIGNED`	`1`	`XSF_SFI_DTYP1`	`Type of first field`
`11`	`(B)`	`UNSIGNED`	`1`	`XSF_SFI_FACTOR`	`Factor for second field`
`12`	`(C)`	`CHARACTER`	`2`	`XSF_SFI_FIELD2`
`12`	`(C)`	`UNSIGNED`	`1`	`XSF_SFI_LEN2`	`Length of second field`
`13`	`(D)`	`UNSIGNED`	`1`	`XSF_SFI_DTYP2`	`Type of second field`
`14`	`(E)`	`CHARACTER`	`8`	`XSF_SFI_COMPVAL`	`The value`

`Len`	`Type`	`Value`	`Name`	`Description`
`Data Types (XSF_SFI_DTYPE, XSF_SFI_DTYP1, XSF_SFI_DTYP2)`
`1`	`HEX`	`00`	`XSF_SFI_DTYPE_UNDEF`	`Undefined data`
`1`	`HEX`	`01`	`XSF_SFI_DTYPE_CHAR_FIX`	`N byte character`
`1`	`HEX`	`02`	`XSF_SFI_DTYPE_BITFLAG`	`Bit flag byte (8 bits)`
`1`	`HEX`	`03`	`XSF_SFI_DTYPE_BIN8`	`1 byte (hex) value`
`1`	`HEX`	`04`	`XSF_SFI_DTYPE_BIN15`	`2 byte hex value`
`1`	`HEX`	`05`	`XSF_SFI_DTYPE_BIN31`	`4 byte hex value`
`1`	`HEX`	`06`	`XSF_SFI_DTYPE_BIN64`	`8 byte hex value`
`1`	`HEX`	`07`	`XSF_SFI_DTYPE_CHAR_VAR`	`Variable length character`
`1`	`HEX`	`08`	`XSF_SFI_DTYPE_COMPOUND`	`Compound SFI`
`1`	`HEX`	`09`	`XSF_SFI_DTYPE_JDATE`	`4 byte packed decimal date YYYYDDD`
`1`	`HEX`	`0A`	`XSF_SFI_DTYPE_TIME`	`4 byte packed decimal time HHMMSST`
`Compound Types (XSF_SFI_CompType)`
`1`	`HEX`	`00`	`XSF_SFI_COMPTYPE_UNDEF`	`Undefined type`
`1`	`HEX`	`01`	`XSF_SFI_COMPTYPE_FACTOR`	`Factored type`
`Factors (XSF_SFI_Factor)`
`1`	`HEX`	`00`	`XSF_SFI_FACTOR_BYTES`	`Value is in bytes`
`1`	`HEX`	`01`	`XSF_SFI_FACTOR_KB`	`Value is in kilobytes`
`1`	`HEX`	`02`	`XSF_SFI_FACTOR_MB`	`Value is in megabytes`
`1`	`HEX`	`03`	`XSF_SFI_FACTOR_GB`	`Value is in gigabytes`
`1`	`HEX`	`04`	`XSF_SFI_FACTOR_TB`	`Value is in terabytes`