@PAR - Define EDT parameter settings

The @PAR statement is used to define the EDT parameter settings. These settings control the screen display, behavior on input, default values for statements and the declaration of special meanings for certain characters.

Operation	Operands	F mode, L mode
@PAR	[ $0..$22 | GLOBAL ] [ [,] parameter[,...] ]

The parameter operand consists of a keyword and the associated assigned value. The following syntax description for the possible values of parameter is organized thematically. The operands in the operand description are ordered alphabetically.

Parameters for the display and output of the work windows in F mode
parameter	EDIT [-] FULL [={ ON ] | OFF} ] EDIT [[-] LONG] [={ ON ] | OFF} ] HEX [={ ON ] | OFF} ] I NDEX [={   ON   ] |  L ONG |  O FF} ] INFORMATION [={ ON ] | OFF} ] OPTIMIZE [={ ON ] | OFF} ] PROTECTION [={ ON ] | OFF} ] SCALE [={ ON ] | OFF} ] SPLIT = {n $0..$22 | n (0..22) | OFF}

Control of behavior on input and data acquisition
parameter	DATA-REPLACEMENT [={ ON ] | OFF} ] INCREMENT = {inc | *STD} LIMIT = {col | *STD} LOWER [={ ON ] | OFF} ] RENUMBER [={ ON ] | OFF} ]

Default settings for other statements
parameter	CODE = {name | EBCDIC I ISO} [ELEMENT [-]] TYPE = {eltype I *STD} LIBRARY = {path I *NONE} SDF-NAME-TYPE = {INTERNAL I EXTERNAL I *STD} SDF-PROGRAM = {progname I *NONE}

Declaration of special meanings for characters
parameter	ESCAPE-CHARACTER = {strspec I *NONE} SEPARATOR = {strchar I *NONE} STRUCTURE = {strchar I *STD} SUBSTITUTION-CHARACTER = {strchar I *NONE}

$0..$22	The work file to which the @PAR statement refers. The comma after the work file specification may only be omitted if no further operands are specified. The operands OPTIMIZE and SUBSTITUTION-CHARACTER always apply to all the work files whereas the SPLIT operand always applies to the current work file. Any work file specification is ignored in these cases. In the case of SPLIT, the warning EDT3127 is also output. If neither $0..$22 nor GLOBAL is specified then the statement applies to the current work file (if neither OPTIMIZE nor SUBSTITUTION-CHARACTER has been specified).
GLOBAL	Specifies that the @PAR statement applies to all the work files. The comma after GLOBAL may only be omitted if no further operands are specified. The SPLIT operand always applies to the current work file (even if GLOBAL is specified). In this case, the specification of GLOBAL is ignored. If neither $0..$22 nor GLOBAL is specified then the statement applies to the current work file (if neither OPTIMIZE nor SUBSTITUTION-CHARACTER has been specified).
CODE=	Specifies the default value of the CODE operand for statements which read or write POSIX files (see section “POSIX files” and the note at the end of the section). When EDT starts, the value EDF041 is set as the default.
name	Name of a valid character set. This is used for the CODE operand in statements which read or write POSIX files unless a character set is explicitly specified for them
EBCDIC	This operand is now only supported for reasons of compatibility. It is synonymous with EDF041.
ISO	This operand is now only supported for reasons of compatibility. It is synonymous with ISO88591.
DATA-REPLACEMENT=
	Specifies whether or not the substitute representation for Unicode characters (see the operand ESCAPE-CHARACTER) is to be taken into account when data is input into the specified work file (in the F mode data window or in L mode) (see section “Substitute character representation in Unicode”). When EDT starts, the value DATA-REPLACEMENT=OFF is set as the default.
ON	When data is input in the specified work file, substitute representations of the form %uxxxx (where % is the escape character defined with @PAR ESCAPE-CHARACTER and the xs are hexadecimal figures) are replaced by the corresponding Unicode characters. This applies when lines are entered in F mode or in L mode but not, for example, when records are read from files or library elements.
OFF	Substitute representations of Unicode characters are only taken into account in literals in EDT statements.
EDIT-FULL=	Determines whether both the data window and statement code column are to be set to overwritable in F mode. This setting is only effective if the line number display is active (@PAR INDEX=ON, resp. @PAR INDEX=LONG). When EDT starts, the value EDIT-FULL=OFF is set as the default.
ON	The data window and the statement code column are both set to overwritable. It is possible to enter a statement code in a line and at the same time to modify data in this line. This means that it is possible to enter statement codes for data lines that have not yet been created, for example the statement code O. Switching to EDIT LONG mode (@PAR EDIT-LONG=ON) or deactivating the line number display (@PAR INDEX=OFF) invalidates this setting. However, the setting is not deactivated. Instead, it is recorded and becomes effective again as soon as the conflicting mode is deactivated. The specification of @PAR EDIT-FULL=ON is ignored as long as write protection (@PAR PROTECTION=ON) is active.
OFF	In a screen line, it is only possible to write the statement code column or the data section.
EDIT-LONG=	Determines whether records that are longer than a screen line are to be displayed in full or truncated in the work window in F mode. When EDT starts, the value EDIT-LONG=OFF is set as the default.
ON	If possible, records are displayed in full in the work window. In EDIT-LONG mode, neither the column counter activated with @PAR SCALE=ON nor an information line requested with @PAR INFORMATION=ON are displayed. The column counter and information lines are not displayed until EDIT- LONG mode is exited. For details of the screen layout in EDIT-LONG mode, see section “The work window”. Activating EDIT-LONG mode implicitly deactivates the line number display (@PAR INDEX=OFF) and hexadecimal mode (@PAR HEX=OFF).
OFF	If necessary, records are displayed in truncated form. The length of the displayed section depends on the terminal and the setting made with @VDT or @PAR INDEX: 70, 72, 80, 122,124 or 132 characters per screen line. The line number display remains active when EDIT-LONG mode is exited. EDIT-LONG mode is also deactivated by @PAR INDEX=ON, @PAR INDEX=LONG and @PAR HEX=ON.
ELEMENT-TYPE=
	Specifies the default element type for library elements. This type of element is accessed if no element type is specified in the @COPY, @OPEN, @DELETE, @WRITE or @INPUT statements (see the note at the end of the section). When EDT starts, the value S is set as the default.
eltype	Permitted type specifications are S, M, P, J, D, X, R, C, H, L, U, F and freely selectable type names having one of these types as basic type. The eltype operand can also be specified as a string variable in the form ELEMENT- TYPE=.svarex. The period must be specified in order to make it possible to distinguish the name of the string variable from a freely selectable type name starting with #. The non-text types (R, C, H, L, U, F) are not permitted in statements used for reading and writing. Specifying them in @PAR ELEMENT-TYPE is therefore only of any use if the default setting is used only for the @DELETE statement. The permitted element types and their meanings are described in section “File processing”.
*STD	Restores the default value (i.e. the value S).
ESCAPE-CHARACTER=
	Specifies the character used to introduce the substitute representation for Unicode characters (see also section “Substitute character representation in Unicode” and the note at the end of the section). When EDT starts, the value ESCAPE-CHARACTER=*NONE is set.
strspec	Special character that acts as an escape character to introduce a Unicode substitute representation. If, for example, @PAR ESCAPE-CHARACTER='%' has been used to declare % as the escape character then a string of the form %Uxxxx with four hexadecimal digits x is interpreted as the substitute representation for the Unicode character with the code xxxx. The setting for @PAR DATA-REPLACEMENT controls whether the substitute representation is only to be taken into account for literals in statements or is also to apply to data input in the work window or in L mode. The escape character for the current work file is always used as the basis for the interpretation of both statements and data input.
*NONE	No escape character is assigned. EDT assumes that the input does not contain any substitute representations.
HEX=	This is used to activate and deactivate hexadecimal mode (see section “Hexadecimal mode”). In F mode, the lines for which hexadecimal mode has been activated are displayed on screen in both printing and hexadecimal form. Details concerning the layout can be found in the section on hexadecimal mode. When EDT starts, the value HEX=OFF is set.
ON	Hexadecimal mode is activated for the specified work file. This implicitly deactivates EDIT-LONG mode. If the same work file is displayed in multiple work windows on the screen then the same setting is used in both data windows. If, in the case of split screen display, the work window is so small that it is not possible to display even one data line together with its hex lines then the message EDT2404 is output. Hexadecimal mode is activated nevertheless. The user can then enlarge the data window so that the hex lines can also be displayed.
OFF	Hexadecimal mode is deactivated.
INCREMENT=
	Specifies the increment that is to be used when line numbers are assigned. For a description of the statements and actions to which this setting applies, see section “Line number assignment”. When EDT starts, the value 1.0 is set as the default.
inc	Increment that is to be used when line numbers are assigned. If @PAR INCREMENT is specified with an increment <0.01 then it should be noted that the line numbers of read, copied or inserted lines are not displayed in full in F mode (6-digit line number display). Unwanted results may occur if these incompletely displayed line numbers are used in statements.
*STD	The default value on EDT start is restored.
INDEX=	Activates and deactivates the line number display in F mode. The screen layout with the line number display activated and deactivated is described in section “F mode”. The setting for the line number display is saved separately for the upper and lower (possible) data windows corresponding to each work file. If only one data window is displayed on the screen then its settings overwrite those of the upper data window for the corresponding work file. If the statement @PAR GLOBAL,INDEX=... has been entered then it applies to all the (possible) screen windows corresponding to all the work files. If only a single work file is specified (including the implicit specification of the current work file) then it is necessary to distinguish between a number of different cases: If the screen is split (see @PAR SPLIT) then the @PAR INDEX statement only applies to the currently visible screen window corresponding to the specified work file. If both screen windows corresponding to the specified work file are visible then the statement applies to the entry window. If neither of the screen windows corresponding to the specified work file are visible then the statement applies to the upper screen window. The equivalent comments apply to input in L mode, where visibility and entry window refer to the state following any switch to F mode (using the @EDIT FULL statement). The corresponding information can be displayed in L mode using @STATUS=PAR(..). If the screen is not split then the statement applies to both (possible) screen windows of the specified work file irrespective of whether these are visible or not. The equivalent comments again apply in L mode, i.e. if a non-split screen is displayed after @EDIT FULL. When EDT starts, the value INDEX=ON is set as default.
ON	The line number display is activated with 2 digits after the decimal point. Specifying @PAR INDEX=ON also deactivates EDIT-LONG mode.
LONG	The line number display is activated with 4 digits after the decimal point. Specifying @PAR INDEX=ON also deactivates EDIT-LONG mode.
OFF	The line number display is deactivated. When the line number display is deactivated, EDIT-FULL mode ceases to be effective but is not deactivated.
INFORMATION=
	In F mode, specifies whether an information line for the specified work file is to be output in the data window. Alongside the number of the work file and the name of the character set defined for this work file if one exists, the information line contains the name of a local @FILE entry or the name of the open file or library element (see section “File processing”). If work file 9 contains the output from one of the statements @FSTAT LONG, @STAJV LONG or @SHOW (without a target specification) and the content has not been changed then the information line in work file 9 contains column headers for the associated output. If none of these cases applies then the information line contains only the number of the work file and the character set. When EDT starts, the value INFORMATION=OFF is set as default.
ON	The information line is displayed as the first line in the work window ahead even of any column counter that may have been activated. The screen display is not modified if the work window is too small to display at least one data line in addition to the information line. The setting does not take effect until the work window is enlarged accordingly.
OFF	No information line is output.
LIBRARY=	Specifies the default library name for the statements @COPY, @OPEN, @WRITE, @INPUT and @SHOW. This default setting is used if no library name is specified in the above-mentioned statements (see note at the end of the section). When EDT starts, the value LIBRARY=*NONE is set as default.
path	Name of the library.
*NONE	The default setting for the library name is reset. In the above-mentioned statements, it is then necessary to specify the library explicitly.
LIMIT=	Defines the maximum record length in the F mode data window. If a record is input with a length which exceeds the specified value then the record is truncated and the message EDT2267 is output. Indirect modifications to records due to statements or data entry in L mode are unaffected by this check. In particular, this parameter has nothing to do with the record length check set using the @CHECK or @TABS statements in L mode. When EDT starts, the value LIMIT=32768 is set as default.
col	The maximum permitted record length (1..32768) for input in the F mode data window.
*STD	The default value on EDT start is restored.
LOWER=	Specifies whether or not EDT converts lowercase characters entered at the terminal into uppercase (see also note at the end of the section). When EDT starts, the value LOWER=ON is set as the default.
ON	EDT differentiates between uppercase and lowercase. Texts and strings are processed in the form that they are entered.
OFF	EDT converts lowercase characters entered at the terminal into uppercase. In F mode, any lowercase characters present in the work file are converted into smudge characters for output in the work window.
OPTIMIZE=	Activates and deactivates the optimization of screen output. Before each screen output, EDT compares the screen that is to be output with the previous screen. By default, it only outputs the modified text in order to improve the output (optimization). The unchanged text in the old screen is retained unmodified. When EDT starts, the value OPTIMIZE=ON is set as default.
ON	In each dialog step, only the modified line contents are output.
OFF	The entire content of the work window is output in each dialog step.
PROTECTION=
	Activates or deactivates record-level write protection. This operand is only of use if the EDT subroutine interface is used. Records can then be marked accordingly to display them as write-protected or overwritable from within the user program (see the Subroutine Interfaces User Guide [1]). When EDT starts, the value PROTECTION=OFF is set as default.
ON	Correspondingly marked records are displayed as write-protected or are automatically set to overwritable in the F mode dialog. If @PAR EDIT-FULL=ON has already been used to set both the statement code column and the data lines to overwritable then this setting is reset.
OFF	The presetting specified by the user program (write-protected or overwritable) does not apply.
RENUMBER=
	Controls the automatic renumbering of line numbers. For a description of the statements and actions to which this setting applies, see section “Line number assignment”. When EDT starts, the value RENUMBER=ON is set as default.
ON	The line numbers in a work file are renumbered if required. EDT does this if the increment is not small enough to execute the statement in full when reading a file (or library element) or when performing a copy or insert operation in a file.
OFF	EDT does not modify the line numbers in a file. EDT issues a message if it is not possible to execute the statement because the increment is not small enough to accommodate all the records.
SCALE=	In F mode, activates or deactivates the display of a column counter (horizontal ruler) in the data window. The column counter is not output in EDIT-LONG mode. In the case of output in hexadecimal mode, there is not just one column counter. Instead, a column counter is output for every line. However, the setting made with @PAR SCALE becomes effective if the corresponding mode is exited. When EDT starts, the value SCALE=OFF is set as default.
ON	The column counter is displayed as the first line after an information line, if one is present (see @PAR INFORMATION), and displays the current work window line numbers for the required work file (e.g. after the work window has been moved horizontally). If a tabulator has been defined (see @TABS statement), an additional screen line is displayed in which the current position of the tabulator is displayed with I. In this line, the tabulator character itself is depicted in the statement code column. If the work window is too small to display at least one data line in addition to the column counter then the column counter is not displayed. As the work window is enlarged, the information line (if present) is shown again first, followed by the column counter and then, finally, the tabulator line (if present).
OFF	Deactivates the column counter and the tabulator display scale if present.
SDF-NAME-TYPE=
	Specifies the name type of the program name which has been predefined with @PAR SDF-PROGRAM as well as the default setting for the name type in the @SDFTEST statement (see also the note at the end of the section). When EDT starts, the value SDF-NAME-TYPE=INTERNAL is set as default.
INTERNAL	The program name is the maximum 8-character internal name. The internal name can be ascertained using SDF-A if it does not correspond to the name of the program.
EXTERNAL	The program name is the maximum 30-character external name (e.g. LMS, SDF-A or HSMS).
*STD	The default value on EDT start is restored.
SDF-PROGRAM=
	Defines the name of a program for the @SDFTEST statement and the statement code T. When this statement or statement code are executed then data lines which start with // are analyzed using this program's syntax file (see also the note at the end of this section). When EDT starts, the value SDF-PROGRAM=*NONE is set as the default.
progname	Name of a program. Either the internal name with a maximum of 8 characters or the external name with a maximum of 30 characters can be defined (see @PAR SDF-NAME-TYPE)
*NONE	*NONE cancels the program definition.
SEPARATOR=
	Specifies the record separator used to delimit records or the character which acts as the default value for the @SEPARATE statement (see section “Statement in data window – splitting a record” or @SEPARATE statement and the note at the end of the section). When EDT starts, the value SEPARATOR=*NONE is set as the default.
strchar	The record separator can be specified as an alphanumeric character or special character in single quotes or in the form U'unicode' in its UTF16 coding. Different characters must be chosen for the record separator and the tabulator character.
*NONE	Cancels a record separator definition. For reasons of compatibility, the keyword OFF is also permitted here.
SPLIT=	In F mode, SPLIT can be used to output a second work window on the screen. The work file in which this statement was entered (current work file) is displayed in the upper work window. The work file specified with $0..$22 is displayed in the lower work window. When EDT starts, the value SPLIT=OFF is set as the default.
n $0..$22 | n (0..22)	The specified work file is displayed with length n in the lower work window. A value of 2 or more must be specified for the length n and this value must not be more than two less than the maximum number of lines permitted by the terminal for the screen format in question (see @VDT statement). The file position (line, column number) in the work file specified here is retained when @PAR is issued. In the subsequent EDT dialog, the file positions of the two work files can be modified individually.
OFF	Hides the second work file and sets the length for the remaining screen window to the maximum value permitted by the terminal. The screen window containing the statement line in which the statement was issued remains present. If @PAR SPLIT = OFF is entered in the upper work window while statements are present in the lower work window then @PAR SPLIT is rejected with an error message. The display of two work windows is also implicitly deactivated by the @VDT statement.
STRUCTURE=
	Specifies the structure symbol that is evaluated when positioning isperformed on the basis of the structure depth (see the statement codes + and -). When EDT starts, the value '@' is set as the default.
strchar	Character that is to be used as the structure symbol. This symbol indicates records which have to be taken into account when positioning is performed on the basis of the structure depth. The character can be specified as an alphanumeric character or special character in single quotes or in the form U'unicode' in its UTF16 coding. If a character other than a blank is defined as the structure symbol then only lines that contain this structure symbol are positioned to when scrolling is performed on the basis of structure depth. If a blank is specified as the structure symbol then it is possible to position to all the lines.
*STD	The default value on EDT start is restored.
SUBSTITUTION-CHARACTER=
	Specifies the substitute character that is used instead of a character which is invalid in the target character set during conversion. The setting applies for all work files and string variables irrespective of the work file in which the @PAR statement was issued. This setting does not apply when characters are converted into the communications character set (see section “Character sets”). In this case, the terminal's device-specific smudge character is always used as the substitute character. When EDT starts, the value SUBSTITUTION-CHARACTER=*NONE is set as the default.
strchar	Character that is used instead of a character which is invalid in the target character set during conversion. The character can be specified as an alphanumeric character or as a special character in single quotes or in the form U'unicode' in its UTF16 coding. Since it is not possible to declare a separate substitute character for every possible target character set, it only makes sense to choose characters which are present in every employed character set. For example, a number of the characters in the EBCDIC DF03 kernel (&-/:.,<*%_+>?) or the character X'00' may be suitable (see section “Character sets”). However, this is not checked on input. If conversion is to be performed using an invalid character set then EDT behaves as if *NONE had been defined for the substitute character.
*NONE	On conversion, no substitute representation is used for characters that are invalid in the target character set. Instead, conversions that would result in such characters are rejected with an error message. Outputs to SYSOUT and SYSLST are an exception this rule. In this case, blanks are used.

If no operands are specified then all the presettings for the current work file (with the exception of SPLIT and OPTIMIZE) are reset to the values that apply when EDT is started. The value for SUBSTITUTION-CHARACTER is always reset to this default value for all the work files.

If only the operands GLOBAL or $1..$22 are specified then all the presettings for all the work files or all the presettings for the specified work file (with the exception of SPLIT and OPTIMIZE) are reset to these default values. The value for SUBSTITUTION-CHARACTER is always reset to this default value for all the work files.

The settings operands are set in the order in which they are specified. This is of significance in the case of parameters which affect one another or when a statement is aborted due to a runtime error (may occur in the case of SPLIT and CODE).

The @PAR statement can also be used in L mode to change settings which affect the display in F mode. Although these take effect immediately, this is, of course, only visible, when processing switches to F mode.

With the exception of INDEX, all the settings for a work file apply irrespective of whether one, both or neither of the possible screen windows for this work file are displayed. Thus, if the same work file is displayed on the screen more than once, the setting applies to both work windows (except in the case of INDEX).

The current values for the settings made with @PAR can be output using the @STATUS statement.

Note

The settings that are made with @PAR (except in the case of OPTIMIZE, SPLIT and SUBSTITUTION-CHARACTER) can be set differently for each work file.
This also applies to the settings made with CODE, ELEMENT-TYPE, ESCAPE-CHARACTER, LIBRARY, LOWER, SDF-NAME-TYPE, SDF-PROGRAM and SEPARATOR which affect the default values or the behavior of another statement (statement using the value). In the case of these settings, the rule is that the value of the work file set as the current work file when the statement using the value is active should apply.
If it is permissible to specify string variables for a value then the value is replaced by the content of the string variables when the @PAR statement is executed. Consequently, any later changes to the string variables have no effect on the setting.