NLMOD - Modify local FT file attributes

The macro NLMOD can be used to modify the FTAM attributes of a file in the local system and adapt the attributes to make them available for a file transfer or file management request. The functionality corresponds to that of the command MODIFY-FILE-FT-ATTRI-BUTES.

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

Name	Operation	Operand
[name]	NLMOD	[MF=L,] FILE=adr [,FPASS={*NONE / adr}] [,PERMACT=[*]UNCHG  /     [,PREADF={[*]NO / [*]YES}]     [,PINSU={[*]NO / [*]YES}]     [,PREPLF={[*]NO / [*]YES}]     [,PEXTDF={[*]NO / [*]YES}]     [,PERAU={[*]NO / [*]YES}]     [,PREADA={[*]NO / [*]YES}]     [,PCHNGA={[*]NO / [*]YES}]     [,PDELF={[*]NO / [*]YES}] [,TRATT=[*]UNCHG  /     [,DATA={[*]UNCHG / [*]BIN / [*]CHAR}]               [,DCHRS={[*]GRSTR / [*]GENER / [*]IA5 /                        [*]VISIB}]     [,RECFORM=[*]UNCHG]     [,RECSIZE={*UNCHG / int}] [,MSGINS={*NONE / adr}] [,AFPASS={[*]GRAPH / [*]OCTET}] [,Version={1 / 2}]

Format of the macro NLMOD (DSECT format)

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

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

xxxNLMO  DSECT
xxxHLMO  FHDR  MF=(C,&P)
xxxFILE  DS    A                    A(FILE-NAME)
xxxFILEL DS    XL2                  L(FILE-NAME)
xxxFPASL DS    XL2                  L(FILE-PASSWORD)
xxxFPAS  DS    A                    A(FILE-PASSWORD)
xxxMSG   DS    A                    A(MESSAGE)
xxxMSGL  DS    XL2                  L(MESSAGE)
*
xxxIFPAS DS    XL1                  FILE-PASSWORD: NONE
xxxIREC  DS    XL1                  RECORD-SIZE: UNCHG
xxxRECS  DS    XL4                  (RECORD-SIZE)
*
xxxTRATT DS    XL1                  TRANSFER-ATTRIBUTES: UNCHG / PAR
xxxDATA  DS    XL1                  DATA-TYPE: UNCHG / BIN / CHAR
xxxCHRS  DS    XL1                  CHAR.SET: GRSTR/GENER/IA5/VISIB
xxxRECF  DS    XL1                  REC.FORMAT: UNCHG
*
xxxPACT  DS    XL1                  PERMITTED-ACTIONS: UNCHG / PAR
xxxPREAF DS    XL1                  READ-FILE:         NO / YES
xxxPINSU DS    XL1                  INSERT-DATA-UNIT:  NO / YES
xxxPREPF DS    XL1                  REPLACE-FILE:      NO / YES
*
xxxPEXTF DS    XL1                  EXTEND-FILE:       NO / YES
xxxPERAU DS    XL1                  ERASE-DATA-UNIT:   NO / YES
xxxPREAA DS    XL1                  READ-ATTRIBUTES:   NO / YES
xxxPCHNA DS    XL1                  CHANGE-ATTRIBUTES: NO / YES
*
xxxPDELF DS    XL1                  DELETE-FILE:       NO / YES
xxxAPAS  DS    XL1                  TYPE-FILE-PASSWORD: GRAPH/OCTET
*
xxxSFPWD DS    XL1                  SET / RESET FILE-PWD: NO / UNCHG
xxxRESRV DS    XL1                  RESERVED
*
xxxFPWD  DS    A                    A(FILE-PASSWORD FOR SET)
xxxFPWDL DS    XL2                  L(FILE-PASSWORD FOR SET)
*
xxxRES2  DS    XL2                  RESERVED
*
*
xxxLNLM  EQU   *-xxx.NLMO

 

Meaning of the fields

The meaning of the parameters in the macro correspond to the meaning of the parameters in the command MODIFY-FILE-FT-ATTRIBUTES. Please refer to the corresponding command description in the manual "openFT (BS2000) - Command Interface ".

Operand (L format)	Address field   (D format)	Meaning in command
FILE	FILE	FILE-NAME
FPASS	FPAS	PASSWORD of the file
PERMACT	PACT	PERMITTED-ACTIONS
PREADF	PREAF	READ-FILE in the structure PERMITTED-ACTION
PINSU	PINSU	INSERT-DATA-UNIT in the structure PERMITTED-ACTION
PREPLF	PREPF	REPLACE-FILE in the structure PERMITTED-ACTION
PEXTDF	PEXTF	EXTEND-FILE in the structure PERMITTED-ACTION
PERAU	PERAU	ERASE-DATA-UNIT in the structure PERMITTED-ACTION
PREADA	PREAA	READ-ATTRIBUTES in the structure PERMITTED-ACTION
PCHNGA	PCHNA	CHANGE-ATTRIBUTES in the structure PERMITTED-ACTION
PDELF	PDELF	DELETE-FILE in the structure PERMITTED-ACTION
TRATT	TRATT	TRANSFER-ATTRIBUTES
DATA	DATA	DATA-TYPE in the structure TRANSFER-ATTRIBUTES
DCHRS	CHRS	CHARACTER-SET in DATA-TYPE
RECFORM	RECF	RECORD-FORMAT in the structure TRANSFER-ATTRIBUTES
RECSIZE	RECS	RECORD-SIZE in the structure TRANSFER-ATTRIBUTES
MSGINS	MSG	Return value of the call
AFPASS	APAS	Coding of the FPASS (GRAPHIC or OCTETT)
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.