Modification Exit Routines Parameters

The linkage of the exit-routine identified in the product PDS COPY by the UDCUSFLW source includes the following fields:

01  UR-ACTION                             PIC  X(04).               
01  UR-FILE-INFO.                                         
    03 UR-FILE-NAME                     PIC  X(128).               
    03 UR-FILE-TYPE                       PIC  X(04).               
01  UR-RECORD                             PIC  X(32760).            
01  UR-FIELD.                                             
    03 UR-INP-VAL                            PIC  X(256).              
    03 UR-POS                                     PIC S9(05) COMP.          
    03 UR-LEN                                     PIC S9(05) COMP.          
    03 UR-TYPE                                   PIC  X(01).               
    03 UR-INT                                      PIC S9(03) COMP.          
    03 UR-DEC                                     PIC S9(03) COMP.          
    03 UR-SIGN                                   PIC  X(01).               
    03 UR-NULL                                  PIC  X(01).          
    03 UR-VARCHAR                         PIC  X(01).          
    03 UR-INULL-VAL                       PIC  X(01).          
       88 UR-VAL-NULL     VALUE  X"6F".        
    03 UR-OTHER-FIELDS-NBR       PIC S9(04) COMP.     
01  UR-OTHER-FIELDS.                                 
    03 OCCURS 50.                                    
       05 UR-P-FILE-NAME                PIC  X(128).          
       05 UR-P-FILE-TYPE                  PIC  X(04).          
       05 UR-P-INP-VAL                      PIC  X(256).         
       05 UR-P-POS                               PIC S9(05) COMP.     
       05 UR-P-LEN                               PIC S9(05) COMP.     
       05 UR-P-TYPE                             PIC  X(01).          
       05 UR-P-INT                                PIC S9(03) COMP.     
       05 UR-P-DEC                               PIC S9(03) COMP.     
       05 UR-P-SIGN                              PIC  X(01).       
       05 UR-P-NULL                             PIC  X(01).       
       05 UR-P-VARCHAR                    PIC  X(01).       
       05 UR-P-INULL-VAL                  PIC  X(01).       
          88 UR-P-VAL-NULL    VALUE  X"6F".     
01 UR-OUTPUT.                                     
    03 UR-OUT-VAL                             PIC  X(256).      
    03 UR-OUT-FLDTYPE                    PIC  X(01).       
    03 UR-OUT-FLDLEN                      PIC S9(03) COMP.  
    03 UR-OUT-FLDINT                       PIC S9(03) COMP.  
    03 UR-OUT-FLDDEC                      PIC S9(03) COMP.  
    03 UR-OUT-FLDSIGN                     PIC  X(01).       
    03 UR-RETCODE                            PIC  X(02).       
    03 UR-MSG-CODE                         PIC  X(07).             
    03 UR-MSG-PARM                         PIC  X(128).            
    03 UR-OUT-TYPE                           PIC  X(01).             
    03 UR-DESCR                                  PIC  X(80).             

These fields are described in the following table:

Field name Input/Output Description
UR-ACTION Input Flag describing the action to be performed. Possible values: INIT - (not used with this product but included for future use) indicates that the call processes a record read from an original file. LAST - indicates that the call has been made at the end of the record processing operation. It is only available to routines customized by the user. AUTH - (not used with this product but included for future use) indicates that the call returns a string containing the author of the exit routine in UR-DESCR VERS - (not used with this product but included for future use) indicates that the call returns a string containing the version of the exit routine in UR-DESCR INFO - (not used with this product but included for future use) indicates that the call returns a string containing the title of the exit routine in UR-DESCR DESC - (not used with this product but included for future use) indicates that the call returns, in UR-DESCR, a row in a table containing the description of the exit routine INPT - (not used with this product but included for future use) indicates that the call returns, in UR-DESCR, a row in a table containing: string 1 (to indicate that the user exit has only one input parameter), the type and the length of the input field OUTP - (not used with this product but included for future use) indicates that the call returns, in UR-DESCR, a row in a table containing: the type and the length of the output field
UR-FILE-NAME Input Not used
UR-FILE-TYPE Input Not used
UR-RECORD Input File Record
UR-INP-VAL Input Value contained in the field to be migrated.
UR-POS Input Position of the field to be migrated inside the record.
UR-LEN Input Length of the field to be migrated.
UR-TYPE Input Type of the field to be migrated.
UR-INT Input Number of integers (for numeric fields only).
UR-DEC Input Number of decimals (for numeric fields only).
UR-SIGN Input Sign of the field to be migrated.
UR-NULL Input Content of any null byte .
UR-VARCHAR Input Length of the VARCHAR field .
UR-INULL-VAL Input Byte value possibly containing the null value .
UR-OTHER-FIELDS-NBR Input Not used
UR-OTHER-FIELDS Input Source encoding type in its UR-P-FILE-NAME field
UR-OUT-VAL Output Value contained in the migrated field
UR-OUT-FLDTYPE Output Not used
UR-OUT-FLDLEN Output Length of the masked value.
UR-OUT-FLDINT Output Not used
UR-OUT-FLDDEC Output Not used
UR-OUT-FLDSIGN Output Not used
UR-RETCODE Output Return code (Space = OK)
UR-MSG-CODE Output Not used
UR-MSG-PARM Output Not used
UR-OUT-TYPE Output Flag describing the location of the processed value. Possible flags: R - The change worked directly on UR-RECORD F - The output value is in UR-OUT-VAL
UR-DESCR Output (Not used now, but included for future use.) It contains additional information about the exit routine.