NDEL - Delete remote file

The macro NDEL is used to delete a file in an FT partner system. Its functionality corresponds to the command DELETE-REMOTE-FILE.

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

Name	Operation	Operand
[name]	NDEL	[MF=L,] PARTNER =adr [,FILE={*NOTSP / adr}] [,FPASS={*NONE / adr}] [,TAD={*NONE / adr}] /     [,UUSER=adr]     [,UACC={*NONE / adr}]     [,UPASS={*NONE / adr}] [,MSGINS={*NONE / adr}] [,AFPASS={[*]GRAPH / [*]OCTET}] [,ATAD={[*]GRAPH / [*]OCTET}] [,AUPASS={[*]GRAPH / [*]OCTET}] [,FNCMODE = {TRANS / CHAR}] [,Version={1 / 2}]

The operands AFPASS, ATAD and AUPASS are used to set the coding type of the file password (FPASS), the transfer admission (TAD) and the user password (UPASS). The operands AFPASS, ATAD and AUPASS can have the value GRAPHIC or OCTET.

With GRAPHIC, the entry for the corresponding operand is interpreted as a printable character, and will be converted during transfer to a system which does not use EBCDIC. With OCTET, it is interpreted as binary information and will not be converted.

Format of the macro NDEL (DSECT format)

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

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

xxxNDEL  DSECT
xxxHDEL  FHDR  MF=(C,&P)
xxxPART  DS    A                    A(PARTNER-SYSTEM)
xxxPARTL DS    XL2                  L(PARTNER-SYSTEM)
xxxFILEL DS    XL2                  L(FILE-NAME)
xxxFILE  DS    A                    A(FILE-NAME)
xxxFPAS  DS    A                    A(FILE-PASSWORD)
xxxFPASL DS    XL2                  L(FILE-PASSWORD)
xxxTADL  DS    XL2                  L(TRANSFER-ADMISSION)
xxxTAD   DS    A                    A(TRANSFER-ADMISSION)
xxxUUS   DS    A                    A(USER-IDENTIFICATION)
xxxUUSL  DS    XL2                  L(USER-IDENTIFICATION)
xxxUACL  DS    XL2                  L(USER-ACCOUNT)
xxxUAC   DS    A                    A(USER-ACCOUNT)
xxxUPA   DS    A                    A(USER-PASSWORD)
xxxUPAL  DS    XL2                  L(USER-PASSWORD)
xxxMSGL  DS    XL2                  L(MESSAGE)
xxxMSG   DS    A                    A(MESSAGE)
*
xxxIFILE DS    XL1                  FILE-NAME:     NOTSP
xxxIFPAS DS    XL1                  FILE-PASSWORD: NONE
xxxITAD  DS    XL1                  TRANSFER-ADMISSION: NONE / PAR
xxxIUAC  DS    XL1                  USER-ACCOUNT:  NONE
*
xxxIUPA  DS    XL1                  USER-PASSWORD: NONE
xxxAPAS  DS    XL1                  TYPE-FILE-PASSWORD: GRAPH/OCTET
xxxATAD  DS    XL1                  TYPE-TRANSFER-ADMS: GRAPH/OCTET
xxxAUPA  DS    XL1                  TYPE-USER-PASSWORD: GRAPH/OCTET
*
xxxFUD   DS    AL4                  A(FURTHER DETAILS)
xxxLFUD  DS    XL2                  L(FURTHER DETAILS)
XXXFNCM  DS    XL1                  FNCMODE = TRANS/CHAR
*
xxxLNDE  EQU   *-xxx.NDEL

Meaning of the fields

The meaning of the parameters in the macro corresponds to the meaning of the parameters in the command DELETE-REMOTE-FILE. Please refer to the corresponding command description in the manual "openFT (BS2000) - Command Interface ".

Operand (L format)	Address field (D format)	Meaning in command
PARTNER	PART	PARTNER-NAME
FILE	FILE	FILE-NAME
FPASS	FPAS	PASSWORD to the file
TAD	TAD	TRANSFER-ADMISSION
UUSER	UUS	USER-IDENTIFICATION in the structure TRANSFER-ADMISSION
UACC	UAC	ACCOUNT in the structure TRANSFER-ADMISSION
UPASS	UPA	PASSWORD for identification in the structure TRANSFER-ADMISSION
MSGINS	MSG	Return value of the call
AFPASS	APAS	Coding of the FPASS (GRAPHIC or OCTET)
ATAD	ATAD	Coding of the TAD (GRAPHIC or OCTET)
AUPASS	AUPA	Coding of the UPASS (corresponding to GRAPHIC or OCTET)
FNCMODE	FNCM	FNC-MODE
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.

After a defective NDEL macro call, additional information (precise cause of the error) concerning the error message itself can be returned in the FUD (Further Details) field. The field must be <= 64 bytes or zero if the additional information is not to be stored in the FUD field.