SET-FILE-LINK

tore attributes of file in TFT

Component:	BS2000
Functional area:	not allocated
Domain:	not allocated
Privileges:	STD-PROCESSING HARDWARE-MAINTENANCE SAT-FILE-EVALUATION SAT-FILE-MANAGEMENT
Routing code:	$ (with NBCONOPI=N) or E (with NBCONOPI=Y)

As of BS2000/OSD V2.0, the SET-FILE-LINK command is superseded by the ADD-FILE-LINK command. SET-FILE-LINK is still supported for reasons of compatibility. The ADD-FILE-LINK command should be used for new applications. This command description is restricted to a brief description and overview of the functions, the syntax format, and the return codes.

Function

The SET-FILE-LINK command saves the specified attribute details for a file, which will normally already exist (e.g. it has been created using a CREATE-FILE command), in the TFT under a particular file link name. These details will then be used when the file is opened, instead of the corresponding details specified in the program.

For more information on the function and purpose of the TFT entry see the Function section of the ADD-FILE-LINK command description. 

Overview of functions

Function / Meaning	Level 1 operands	Level 2/3 operands
Define the file link name for which a TFT entry is to be created	LINK-NAME
Name of file/file generation to which the SET-FILE-LINK command relates	FILE-NAME
Access method (ISAM, SAM, BTAM ...)	ACCESS-METHOD
Access method ISAM	=*ISAM
key length		KEY-LENGTH
key position		KEY-POSITION
immediate writing out of amended blocks		WRITE-IMMEDIATE
duplicate keys		DUPLICATE-KEY
block padding (for sequential processing)		PADDING-FACTOR
length of value flag		VALUE-FLAG-LENGTH
evaluation of value flags		PROPAGATE-VALUE-FLAG
length of logical flags		LOGICAL-FLAG-LENGTH
overlapped processing		READ-IN-ADVANCE
define pool link names for the user ISAM pool (NK-ISAM files)		POOL-LINK
OPEN mode	OPEN-MODE
Record format	RECORD-FORMAT
variable record length	=*VARIABLE	RECORD-SIZE
fixed record length	=*FIXED	RECORD-SIZE
undefined record length	=*UNDEFINED	RECORD-SIZE
Block length	BUFFER-LENGTH
Specify device	SUPPORT
Disk processing	=*DISK
mount a private disk		VOLUME-ALLOCATION
shared update processing		SHARED-UPDATE
read-after-write check		WRITE-CHECK
performance attributes		IO-ATTRIBUTES
closing mode		CLOSE-MODE
Tape processing	=*TAPE
mount request		PREMOUNT-LIST
tapes to mount		VOLUME-LIST
labels
label checking define scope		LABEL-CHECK
security level		PROTECTION-LEVEL
supplementary checks		OVERWRITE-PROTECTION
bypass label checking		BYPASS
tape positioning		POSITION
specify label attributes		LABEL
Define conversion table		CODE
EBCDIC conversion		EBCDIC-TRANSLATION
Position tape within a FILE SET		FILE-SEQUENCE
Automatic checkpoint writing		CHECKPOINT-POSITION
Buffer offset		BLOCK-OFFSET
Retention period		RETENTION-PERIOD
Buffered/unbuffered processing		TAPE-WRITE
Overwrite residual data		DESTROY-OLD-CONTENTS
Closing mode		CLOSE-MODE
Chained input/output	IO-CHAINING
Define file format (BLKCTRL)	BLOCK-CONTROL-INFO
Output of message on completion of CLOSE processing	FILE-CLOSE-MSG

Table 85: Overview of the SET-FILE-LINK command functions

Format

SET-FILE-LINK

LINK-NAME = <filename 1..8 without-gen>
,FILE-NAME = *BY-PROGRAM / *DUMMY / <filename 1..54>
,ACCESS-METHOD = *BY-PROGRAM / *BY-CATALOG / *SAM / *PAM / *BTAM / *UPAM / [*ISAM](...)
	[*ISAM](...)
		|		KEY-LENGTH = *BY-PROGRAM / *BY-CATALOG / <integer 1..255>
		|		,KEY-POSITION = *BY-PROGRAM / *BY-CATALOG / <integer 1..32767>
		|		,WRITE-IMMEDIATE = *BY-PROGRAM / *NO / *YES
		|		,DUPLICATE-KEY = *BY-PROGRAM / *YES / *NO
		|		,PADDING-FACTOR = *BY-PROGRAM / <integer 0..99>
		|		,VALUE-FLAG-LENGTH = *BY-PROGRAM / *BY-CATALOG / <integer 0..255>
		|		,PROPAGATE-VALUE-FLAG = *BY-PROGRAM / *MINIMUM / *MAXIMUM / *BY-CATALOG
		|		,LOGICAL-FLAG-LENGTH = *BY-PROGRAM / *BY-CATALOG / <integer 0..255>
		|		,READ-IN-ADVANCE = *BY-PROGRAM / *YES / *NO
		|		,POOL-LINK = *BY-PROGRAM / <name 1..8>
,OPEN-MODE = *BY-PROGRAM / *INPUT / *OUTPUT / *EXTEND / *REVERSE / *UPDATE / *OUTIN /
*INOUT / *SINOUT
,RECORD-FORMAT = *BY-PROGRAM / *VARIABLE(...) / *FIXED(...) / *UNDEFINED(...) / *BY-CATALOG
	*VARIABLE(...)
		|		RECORD-SIZE = *BY-PROGRAM / *BUFFER-LENGTH / <integer 4..32768>
		|		,PRINT-CONTROL = *BY-PROGRAM / *NONE / *ASA / *EBCDIC
	*FIXED(...)
		|		RECORD-SIZE = *BY-PROGRAM / <integer 1..32768>
		|		,PRINT-CONTROL = *BY-PROGRAM / *NONE / *ASA / *EBCDIC
	*UNDEFINED(...)
		|		REGISTER-NUMBER = *BY-PROGRAM / <integer 2..12>
		|		,PRINT-CONTROL = *BY-PROGRAM / *NONE / *ASA / *EBCDIC
,BUFFER-LENGTH = *BY-PROGRAM / *BY-CATALOG / [*STD](...) / <integer 1..32768>
	[*STD](...)
		|		SIZE = 1 / <integer 1..16>
,SUPPORT = *NONE / *DISK(...) / *TAPE(...)
	*DISK(...)
		|		VOLUME-ALLOCATION = *IMMEDIATE / *DELAYED
		|		,SHARED-UPDATE = *BY-PROGRAM / *NO / *YES / *WEAK
		|		,WRITE-CHECK = *BY-PROGRAM / *NO / *YES
		|		,RETENTION-PERIOD = *BY-PROGRAM / <integer 0..32767>
		|		,IO-ATTRIBUTES = *BY-PROGRAM / *BY-CATALOG / *STD / [*PARAMETERS](...)
		|			[*PARAMETERS](...)
		|				|		PERFORMANCE = *BY-PROGRAM / *BY-CATALOG / *STD / *HIGH / *VERY-HIGH /
		|				|		*USER-MAX
		|				|		,USAGE = *BY-PROGRAM / *BY-CATALOG / *READ-WRITE / *WRITE / *READ
		|		,CLOSE-MODE = *BY-PROGRAM / *INVALIDATE
	*TAPE(...)
		|		PREMOUNT-LIST = *NONE / list-poss(255): <integer 0..255>
		|		,VOLUME-LIST = *BY-CATALOG (...) / *BY-TAPE-SET(...) / list-poss(255): <alphanum-name 1..6>
		|			*BY-CATALOG(...)
		|				|		START-POSITION = *BY-PROGRAM / list-poss(255): <integer 1..255>
		|			*BY-TAPE-SET(...)
		|				|		TAPE-SET-NAME = <alphanum-name 1..4>
		|		,LABEL-CHECK = *BY-PROGRAM / *PARAMETERS(...) / *BYPASS(...)
		|			*PARAMETERS(...)
		|				|		PROTECTION-LEVEL = *LOW / *HIGH
		|				|		,OVERWRITE-PROTECTION = *NO / *YES
		|			*BYPASS(...)
		|				|		POSITION = *NO / *ABSOLUTE(...) / *FORWARD(...) / *BACKWARD(...)
		|				|			*ABSOLUTE(...)
		|				|				|	TAPE-MARK = <integer 0..32767>
		|				|			*FORWARD(...)
		|				|				|	TAPE-MARK = <integer 0..127>
		|				|			*BACKWARD(...)
		|				|				|	TAPE-MARK = <integer 0..127>
		|		,LABEL = *BY-PROGRAM / *STD(...) / *NON-STD(...) / *NO(...)
		|			*STD(...)
		|				|		DIN-REVISION-NUMBER = *HIGHEST / <integer 0..3>
		|			*NON-STD(...)
		|				|		TAPE-MARK = *BY-PROGRAM / *YES / *NO
		|			*NO(...)
		|				|		TAPE-MARK = *BY-PROGRAM / *YES / *NO
		|		,CODE = *BY-PROGRAM / *BY-CATALOG / *EBCDIC / *ISO7 / *OWN
		|		,EBCDIC-TRANSLATION = *BY-PROGRAM / *YES / *NO
		|		,FILE-SEQUENCE = *BY-PROGRAM / *BY-CATALOG / *UNKNOWN / *NEW / <integer 0..9999>
		|		,CHECKPOINT-POSITION = *BY-PROGRAM / *NO(...) / *FORCED-EOV(...) / *BLOCK-LIMIT(...) /
		|		*LATEST(...)
		|			*NO(...)
		|				|		RESTART-USAGE = *Y ES / *DUMMY
		|			*FORCED-EOV(...)
		|				|		RESTART-USAGE = *Y ES / *DUMMY
		|			*BLOCK-LIMIT(...)
		|				|		NUMBER-OF-BLOCKS = <integer 1..999999>
		|				|		,RESTART-USAGE = *Y ES / *DUMMY
		|			*LATEST(...)
		|				|		NUMBER-OF-BLOCKS = <integer 1..999999>
		|				|		,RESTART-USAGE = *Y ES / *DUMMY
		|		,BLOCK-OFFSET = *BY-PROGRAM / *BY-CATALOG / *BY-HDR2 / <integer 0..99>
		|		,RETENTION-PERIOD = *BY-PROGRAM / <integer 0..32767>
		|		,STREAM = *NO / YES / *NO
		|		,TAPE-WRITE = *BY-PROGRAM / *DEVICE-BUFFER / *IMMEDIATE
		|		,DESTROY-OLD-CONTENTS = *STD / *NO / *YES
		|		,CLOSE-MODE = *BY-PROGRAM / *REWIND / *REPOS / *UNLOAD / *LEAVE
,IO-CHAINING = *BY-PROGRAM / <integer 1..16> / *BY-PROGRAM
,BLOCK-CONTROL-INFO = *BY-PROGRAM / *BY-CATALOG / *NO / *WITHIN-DATA-BLOCK /
*WITHIN-DATA-2K-BLOCK / *WITHIN-DATA-4K-BLOCK / *PAMKEY
,FILE-CLOSE-MSG = *STD / *NO / *YES

Return codes

(SC2)	SC1	Maincode	Meaning
	0	CMD0001	Command executed
2	0	DMS0546	Catalog entry for specified file has reached maximum size
2	0	DMS054A	Insufficient disk space or access to disk not possible
	1	DMS0576	Invalid operand combination
	1	CMD0202	Syntactical or semantic error in command
	32	DMS0584	A state that does not allow the function to continue was reported during processing
	32	DMS05C7	Unexpected internal error in DMS
	64	CMD0216	Privileges error
	64	DMS0501	Requested catalog not available
	64	DMS0512	Requested catalog cannot be found
	64	DMS051B	Requested user ID not in pubset
	64	DMS051C	User not authorized to access pubset
	64	DMS0535	Specified file not shareable
	64	DMS0585	Error detected when processing catalog or multiprocessor system
	64	DMS0586	It is not possible to access or reserve a volume at present
	64	DMS0587	Use of the specified command has been restricted by the system administrator
	64	DMS0588	It was not possible to allocate disk space
	64	DMS05FC	Specified user ID not in HOME pubset
	64	DMS06C4	File generation group not yet cataloged
	64	DMS06FF	BCAM connection severed
	128	DMS0506	Function not executed due to change in master
	130	DMS0524	System address space exhausted
	130	DMS053C	Insufficient space for catalog file on pubset
	130	DMS0582	File is currently locked or being used and cannot be processed
	130	DMS0585	Error detected when processing catalog or multiprocessor system
	130	DMS0586	It is not possible to access or reserve a volume at present
	130	DMS0588	It was not possible to allocate disk space
	130	DMS0594	Not enough virtual memory available
	130	DMS05C8	Maximum permitted number of files reached