NCAN - Cancel file transfer request

The macro NCAN can be used to reverse an FT request or cancel the file transfer. openFT deletes the FT request which meets the specified selection criteria from the request file and cancels the corresponding file transfer. The functionality corresponds to the command described in the manual "openFT (BS2000) - Command Interface " under CANCEL-FILE-TRANSFER (NCANCEL).

Format of the macro NCAN (LIST format/default format)

Name	Operation	Operand
[name]	NCAN	[MF=L,]  [TRANSID=adr]  [,SOWNER=adr]  [,PARTNER=adr]  [{,LFILE=adr/    ,LLIB=adr[,LEL=adr][,LELVER=adr][,LELTYP=adr]}]  [,JVNAME=adr]  [,JVPASS=adr]  [,INIT={BOTH / LOCAL / REMOTE}]  [,FORCE={NO / YES}  [,Version={1 / 2}]

Format of the macro NCAN (DSECT format)

Name	Operation	Operand
[name]	NCAN	MF=(D[,xxx])

The prefix xxx (default value YNA) may be up to 3 characters long. It must generate names which are permitted in ASSEMBLER. The following ASSEMBLER instructions are generated:

xxxNCAN  DSECT
xxxHCAN  FHDR  MF=(C,&P)
xxxTRID  DS    A                       A(TRANSFER-ID)
xxxTRIDL DS    XL2                     L(TRANSFER-ID)
xxxLNCA1 EQU   *-xxxNCAN               L(MACRO VERSION 1)
*
xxxSOWNL DS    XL2                     L(OWNER-ID)
xxxSOWN  DS    AL4                     A(OWNER-ID)
xxxPART  DS    AL4                     A(PARTNER-SYSTEM)
xxxPARTL DS    XL2                     L(PARTNER-SYSTEM)
xxxLFILL DS    XL2                     L(FILE-NAME)
xxxLFIL  DS    AL4                     A(FILE-NAME)
xxxLLIB  DS    AL4                     A(LIBRARY-NAME)
xxxLLIBL DS    XL2                     L(LIBRARY-NAME)
xxxLELL  DS    XL2                     L(ELEMENT-NAME)
xxxLEL   DS    AL4                     A(ELEMENT-NAME)
xxxLEV   DS    AL4                     A(ELEMENT-VERSION)
xxxLEVL  DS    XL2                     L(ELEMENT-VERSION)
xxxLETYL DS    XL2                     L(ELEMENT-TYPE)
xxxLETY  DS    AL4                     A(ELEMENT-TYPE)
xxxJVNM  DS    AL4                     A(JV-NAME)
xxxJVNML DS    XL2                     L(JV-NAME)
xxxJVPSL DS    XL2                     L(JV-PASSWORD)
xxxJVPS  DS    AL4                     A(JV-PASSWORD)
xxxINIT  DS    XL1                     INITIATOR
*
xxxIBOTH EQU   0                       INITIATOR = BOTH
xxxILOC  EQU   192                     INITIATOR = LOCAL
xxxIREM  EQU   128                     INITIATOR = REMOTE
*
&P.LNCA2  EQU   *-&.NCAN               L(MACRO VERSION 2)
*
&P.FORCE DS    XL1                     FORCE-CANCELLATION
xxxFNO   EQU   X’00’                   FORCE = NO
xxxFYES  EQU   X’01’                   FORCE = YES
*
xxxLNCA EQU *-xxxNCAN

Meaning of the fields

The macro NCAN offers you the same options as the command CANCEL-FILE-TRANSFER (NCANCEL). Please refer to the command description. The following table shows how the parameters in the macro NCAN correspond to the command operands:

Operand (L format)	Address fields   (D format)	Meaning in command
TRANSID	TRID	TRANSFER-ID
SOWNER	SOWN	OWNER-IDENTIFICATION
PARTNER	PART	PARTNER-NAME
LFILE	LFIL	FILE-NAME
LLIB	LLIB	LIBRARY
LEL	LEL	ELEMENT
LELVER	LEV	VERSION
LELTYP	LETY	TYPE
JVNAME	JVNM	MONJV
JVPASS	JVPS	JV-PASSWORD
INIT	INIT	INITIATOR
FORCE	FORCE	FORCE-CANCELLATION
VERSION	FCTV	(Type of return code output (old/new))1

¹Depending on the value of the VERSION operand, the FUNCTION INTERFACE VERSION NUMBER is set in the header FHDR

If you do not enter anything in the fields for the OWNER-ID, your own user ID will be used as the value (this corresponds to the default entry *OWN at the command interface. If you intentionally fill the OWNER-ID field with blanks, then all user IDs will be used (this corresponds to the entry *ALL at the command interface).

You may only set FORCE=YES if you have explicitly specified a transfer ID in the TRID field. This request must already have been cancelled with FORCE=NO. Only login names that possess the FDT-ADM privilege may specify FORCE=YES.