Return information and error displays

After every CALL macro to openFT (BS2000), return information is provided in the structure FT-RETURN-INFO.

FT-RETURN-INFO

The range FT-RETURN-INFO describes the return information returned by openFT (BS2000). FT-RETURN-INFO must be defined in the WORKING-STORAGE SECTION and can be copied to there with the statement

COPY FTRETC OF linkname.

FT-RETURN-INFO is defined as follows:

 01  FT-RETURN-INFO.
     05 FILLER                  PIC X(4)   VALUE "121C".
     05 TRANSFER-ID             PIC X(10).
*
     05 FT-RETURN-CODE.
         10 MAIN-RETURN-CODE    PIC S9(5) COMP.
             88 OKAY                       VALUE 0.
         10 SUB-RETURN-CODE     PIC S9(5) COMP.
         10 NEW-SUB-RETURN-CODE REDEFINES SUB-RETURN-CODE.
             15 SUB-RETURN-CODE2   PIC S9(2) COMP.
             15 SUB-RETURN-CODE1   PIC S9(2) COMP. 
*
         10 DMS-RETCODE         PIC X(8).
         10 LINK-RETCODE REDEFINES DMS-RETCODE PIC X(8).
*

The version specification at the beginning of the structure FT-NCOPY-LIST serves to identify the COPY element and must not be overwritten.

Description of the data fields

TRANSFER-ID

The fields contains

• after a successful NCOPY macro, the transfer ID of the generated request (left-justified, filled with right-justified blanks)
  or

• after an unsuccessful NCOPY macro, the character string ’##########’.

For a NCANCEL-/NSTATUS macro, the fields remains unchanged.

For a NMOD-/NSHOW-/NDEL-/NLMOD- or NLSHOW macro, the field has no meaning.

FT-RETURN-CODE

This field contains the return messages.

NEW-SUB-RETURN-CODE

This field Redefines SUB-RETURN-CODE field as SUB-RETURN-CODE2 and SUB-RETURN-CODE1.

Return codes

The INTERFACE-VERSION parameter makes it possible to select either the old or the new return code output. If you select the old return code output (default value), then the compatibility of older programs is maintained, i.e. they can be used without adaptation. If you want to use the new return codes then you must adapt and recompile the programs.

[,INTERFACE-VERSION={0 / 1}]

Value	Meaning
0 (default value)	Uses conventional return code output.
1	Uses the new return code output.
Incorrect specification	Uses the conventional return code output and generates an MNOTE ’OLD RETURN CODES USED’.

Set-up of the FT-RETURN-CODE field

The new return code output is described in section "Format of the return codes" in chapter "ASSEMBLER programming interface".

The old return code output is as follows:

The field with the return code meets the conventions for return codes as of BS2000 Version 9.

Return codes for NCOPY, NDEL, NMOD and NSHOW

The new return codes for the functions NCOPY, NDEL, NMOD and NSHOW are listed in section “Return codes for NCOPY, NDEL, NLMOD, NLSHOW, NMOD and NSHOW” in chapter "ASSEMBLER programming interface".