BLSQMDEF — Define a control block format model

Description

The BLSQMDEF macro starts and ends the definition of a control block format model. The end of the model is indicated by a BLSQMDEF macro with only the END keyword specified.

The BLSQMDEF and BLSQMFLD macros work together to create a formatting model. This is the structure of the formatting model:

One BLSQMDEF macro to begin the model definition.
At least one BLSQMFLD macro to define the attributes of a desired control block field.
One BLSQMDEF macro to end the model definition.

The order of the BLSQMFLD statements in the formatting model determines the order of the fields in the output of the formatting process. Only the BLSQMFLD macro can be placed between the BLSQMDEF macros that delimit the start and end of the model definition. Use the BLSQSHDR macro, which defines text strings to be displayed in the formatted output, to clarify the data. Place BLSQSHDR after the second BLSQMDEF.

BLSQMDEF, BLSQMFLD, and BLSQSHDR allow interactive problem control system (IPCS) and SNAP users to specify the presentation of data and messages produced by user-written exit routines.

See z/OS MVS IPCS Customization for information about format models.

Environment

Because BLSQMDEF is not an executable macro, there are no specific environment requirements.

Programming requirements

None.

Restrictions

None.

Register information

Because BLSQMDEF is not an executable macro, there is no need to save and restore register contents.

Performance implications

None.

Syntax

The standard form of the BLSQMDEF macro is written as follows:

Syntax	Description

`name`	`name`: Symbol. Begin `name` in column 1

␢	One or more blanks must precede BLSQMDEF.

BLSQMDEF

␢	One or more blanks must follow BLSQMDEF.

END	END is required when the BLSQMDEF macro is terminating the current format model definition. When END is specified, no other options are allowed.

,BASELBL=`label`	`label`: Symbol.

,CBLEN=`value`	`value`: Decimal constant, hexadecimal constant, or an absolute value.
	CBLEN is required unless the END parameter is specified.

,MAINTLV=`name`	`name`: 1 to 8 byte character string.

,ACRONYM=`name`	`name`: 1 to 8 byte character string
	When ACRONYM is specified, the ACROLBL or ACROFF parameters must also be specified. When neither ACROLBL nor ACROFF are specified, a default zero is assumed.

,ACROLEN=`value`	`value`: Decimal constant, hexadecimal constant, or absolute expression of a number from 1 to 8.

,ACROLBL=`label`	`label`: Symbol.
	Use ACROLBL only when BASELBL is specified.

,ACROFF=`value`	`value`: Decimal constant, hexadecimal constant, or absolute value.
	Use ACROFF when ACRONYM is not at offset zero and BASELBL is not specified, or when both ACROFF and ACROLBL are specified.

,PREFIX=`value`	`value`: Integer constant 0 - 8 inclusive.
	Default: PREFIX=3

,OFFSETS=PRINT	Default: OFFSETS=PRINT
	,OFFSETS=NOPRINT

,STRTCOL=`value`	`value`: Decimal constant, hexadecimal constant, or an absolute expression.
	Default: STRTCOL=0

,LBLSPC=`value`	`value`: Decimal constant, hexadecimal constant, or an absolute expression.
	Default: LBLSPC=0

,HEADER=`name`	`name`: One to eight byte character string.
	When HEADER is not specified, ACRONYM value is used.
	When neither HEADER nor ACRONYM is specified, only the virtual address of the block is displayed as a header.

,VIEWMATCH=VALUE	Default: View matching by value.

Parameters

The parameters are explained as follows:

END: Specifies the termination of the control block model. This parameter is required to end the control block definition. When this parameter is specified all other parameters are ignored.
,BASELBL=label: Specifies the label of an assembler statement, used to calculate field offsets. When specified, all field offsets calculated by the BLSQMFLD macro are relative to this label. When not specified, all field offsets must be explicitly specified on the BLSQMFLD macro via the OFF parameter.
,CBLEN=value: Specifies the total length of the control block. Value may be a decimal constant, a hexadecimal constant, or an absolute expression of a number from 0 to 32767. If a length of zero is specified, the length of the control block must be separately specified when the model is used. This parameter is required except when the END parameter is specified. This value is used when the format model processor service accesses the data from the dump on behalf of the calling exit program.
,MAINTLV=name: Specifies the maintenance level of the control block. The maintenance level name may be a 1 to 8 byte character string that contains no blanks.
,ACRONYM=name: Specifies the contents of the control block acronym field. Name may be a one to eight byte character string that contains no blanks. When this field is specified, the ACROLBL or ACROFF parameter should also be specified to define the offset of the acronym field within the control block. When neither the ACROLBL nor the ACROFF parameter is specified, an offset of zero is assumed. The model processor service compares the contents of the data at the specified offset and length with this name when the calling exit program requests the option to check acronyms. The name is also used to form the dump header when the header keyword is not coded.
,ACROLEN=value: Specifies the length of the acronym name, defined by the ACRONYM parameter, when the acronym name requires blanks. When omitted, the length is the actual length of the name specified in the ACRONYM parameter without blanks. Value may be a decimal constant, hexadecimal constant, or absolute expression of a number from zero to eight.
,ACROLBL=label: Specifies the label on the assembler statement that defines the acronym field. This label is used with the label provided by BASELBL to calculate the acronym field offset. Use this parameter only when BASELBL is specified. The ACROLBL parameter is ignored when ACROFF is specified.
,ACROFF=value: Specifies the offset of the field containing the control block acronym within the control block. Use this parameter when the acronym is not at offset zero and BASELBL is not specified. Value may be a decimal constant, hexadecimal constant, or absolute expression.
,PREFIX=value: Specifies the number of characters to be removed from the front of a field name to produce the field label. The field name is defined by the NAME parameter of the BLSQMFLD macro. Value must be an integer constant 0 - 8. When PREFIX=8 is specified, the fields have no labels, and the model processor service does not allocate print buffer space for labels. This is called "no-label mode" and is used to produce denser data output. When not specified, the default is PREFIX=3. PREFIX may be re-specified on a succeeding BLSQMFLD macro.
,OFFSETS=PRINT
,OFFSETS=NOPRINT: Specifies whether the field offset information should be printed at the beginning of each output line of the formatted control block. PRINT specifies that offset information should be included on the formatted line; NOPRINT causes the offset information to be suppressed. When this parameter is not specified, a default of PRINT is used. Specifying OFFSETS=NOPRINT is identical to setting bit ADPLPSOF in field ADPLPOPT to B'1'; both the OFFSETS=NOPRINT parameter and the ADPLPSOF bit suppress offsets. ADPLPOPT is mapped by the BLSABDPL macro.
,STRTCOL=value: Specifies a left margin for each line of the formatted control block. Value may be a decimal constant, a hexadecimal constant, or an absolute expression. When not specified, or specified as zero, the format model processor uses the value specified by IPCS or SNAP in the field ADPLSCOL in ADPLEXTN, which is mapped by the BLSABDPL macro.
,LBLSPC=value: Specifies the spacing between label fields in the formatted output. Value may be a decimal constant, hexadecimal constant, or an absolute expression. When not specified, or specified as zero, it indicates to the format model processor that the value specified by IPCS or SNAP should be used in field ADPLCOLS in ADPLEXTN, which is mapped by the BLSABDPL macro. The LBLSPC value is initially set to 20.
Note: When value is 18, the output is condensed.
,HEADER=name: Specifies the heading that precedes the formatted control block. The heading consists of either the HEADER or ACRONYM followed by the virtual address of the block. Name may be any one to eight byte character string that contains no blanks. When HEADER is omitted, the ACRONYM value is used for the heading. When neither the ACRONYM parameter nor the HEADER parameter is specified, the formatted control block has the virtual address as a heading.
,VIEWMATCH=VALUE: Specifies that the first eight bits of the view control fields in the format parameter and a model entry must match to process that model entry. When not specified, any bit match in the first 12 bits is sufficient. Rules for the component portion of the view apply in both cases.