The macro CALL "NCANCEL"... can be used to reverse FT requests or cancel the file transfer. openFT (BS2000) deletes the FT requests from the FT request file which meet the selection criteria specified and cancels any related file transfers. The functionality corresponds to that of the command CANCEL-FILE-TRANSFER (NCANCEL)
Macro
The function can be called as follows:
CALL "NCANCEL" USING FT-NCANCEL-LIST FT-RETURN-INFO.
FT-NCANCEL-LIST
The range FT-NCANCEL-LIST describes the parameter list for the NCANCEL macro. FT-NCANCEL-LIST must be defined in the WORKING-STORAGE SECTION and can be copied to there with the statement
COPY FTNCAN OF linkname.
Before executing the macro you must fill the desired fields. If a parameter is not specified or the default value is to be used, this field must be assigned the value LOW-VALUE.
FT-NCANCEL-LIST is defined as follows:
01 FT-NCANCEL-LIST.
*
02 FILLER PIC X(4) VALUE "1000".
*
02 USER-PARAMETERS.
*
05 TRANSFER-ID PIC X(10).
88 SELECT-ALL VALUE LOW-VALUE.
*
05 SELECT-PARAMETER.
*
10 OWNER-IDENTIFICATION PIC X(8).
88 OWN VALUE LOW-VALUE.
88 SELECT-ALL VALUE " ".
*
10 INITIATOR PIC X(1).
88 SELECT-ALL VALUE LOW-VALUE.
88 LOCAL VALUE "L".
88 REMOTE VALUE "R".
*
10 PARTNER-NAME PIC X(200).
88 SELECT-ALL VALUE LOW-VALUE.
*
10 FILE-NAME PIC X(512).
88 SELECT-ALL VALUE LOW-VALUE.
10 LIBRARY PIC X(56).
88 SELECT-ALL VALUE LOW-VALUE.
10 ELEMENT PIC X(64).
88 SELECT-ALL VALUE LOW-VALUE.
10 TYP PIC X(8).
88 SELECT-ALL VALUE LOW-VALUE.
10 VERSION PIC X(24).
88 SELECT-ALL VALUE LOW-VALUE.
*
10 MONJV PIC X(56).
88 NONE VALUE LOW-VALUE.
*
10 JV-PASSWORD PIC X(11).
88 NONE VALUE LOW-VALUE.
*
05 FORCE-CANCELLATION PIC X(1).
88 NO VALUE LOW-VALUE.
88 YES VALUE "Y".
The version specification at the beginning of the structure serves to identify the COPY element and must not be overwritten by the user.
If more than one selection criterion is specified in the NCANCEL macro, a request can be overdefined, for instance, if both TRANSFER-ID and MONJV are specified. If the criteria contradict each other in such a case, the NCANCEL macro is not executed.
You may only set YES if you have explicitly specified a transfer ID in the TRANSFER-ID field. This request must already have been cancelled with FORCE-CANCELLATION=NO and is only possible if the user ID possesses the FT-ADM privilege.
Description of the data fields
The parameters for FT-NCANCEL-LIST have the same name and functions as the corresponding operands for the command CANCEL-FILE-TRANSFER (NCANCEL). Please refer to the corresponding command description in the manual "openFT (BS2000) - Command Interface ".
NCANCEL example
***************************************************************
* EXAMPLE : *
* *
* CANCELLATION OF A FILE TRANSFER REQUEST *
* FROM A COBOL PROGRAM *
***************************************************************
IDENTIFICATION DIVISION.
PROGRAM-ID. NCA.
*
ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
SPECIAL-NAMES.
TERMINAL IS TERM.
*
DATA DIVISION.
WORKING-STORAGE SECTION.
77 MAIN-RCODE-STRING PIC -ZZZZ9.
77 SUB-RCODE-STRING PIC -ZZZZ9.
COPY FTNCAN OF FTLIB.
COPY FTRETC OF FTLIB.
*
PROCEDURE DIVISION.
CONTROL SECTION.
ST-01.
*
*TRANS-ID-READING.
DISPLAY "PLEASE ENTER TRANSFER-ID" AT TERM.
ACCEPT TRANSFER-ID IN FT-NCANCEL-LIST FROM TERM.
*
*NCANCEL-CALLING.
CALL "NCANCEL" USING FT-NCANCEL-LIST FT-RETURN-INFO.
*
*RESULT-HANDLING.
IF OKAY IN MAIN-RETURN-CODE
DISPLAY "FILE TRANSFER REQUEST CANCELLED"
UPON TERM
ELSE
MOVE MAIN-RETURN-CODE TO MAIN-RCODE-STRING
MOVE SUB-RETURN-CODE TO SUB-RCODE-STRING
DISPLAY "TRANSFER CANCELLATION REJECTED" UPON TERM
DISPLAY "MAIN-RETURN-CODE: " MAIN-RCODE-STRING
" SUB-RETURN-CODE: " SUB-RCODE-STRING
UPON TERM.
ST-99.
STOP RUN.