Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.63 KB

block-macros.md

File metadata and controls

66 lines (43 loc) · 2.63 KB
Raw
title description keywords ms.date
Block Macros
A block macro is used to delimit a set of GPD file entries that you want to insert repeatedly into a GPD file
block macros WDK GPD files
referencing macros
01/26/2023

Block macros

[!includePrint Support Apps]

A block macro is used to delimit a set of GPD file entries that you want to insert repeatedly into a GPD file. You can include any entry type in a block macro definition, such as feature and option statements, attribute specifications, and references to value macros or other block macros.

The following rules apply to the use of block macros:

  • A block macro definition within a GPD file must be located before any references to it.

  • A block macro defined at root level (that is, not inside braces) is available through the GPD file that defines it, after it's defined. Otherwise, the scope of a block macro is the set of left and right braces containing its definition.

  • A block macro definition can contain definitions of additional block macros and value macros.

  • A block macro definition can reference other previously defined block macros and value macros, but it can't reference itself.

  • Block macros don't accept arguments.

  • If braces are included in a macro body, they must be paired (that is, there must be an equal number of left and right braces).

  • If you create two block macros with the same name, the first definition is in effect until the GPD parser encounters the second definition. The second definition then replaces the first. If the scope of the second definition ends, the first definition is reinstated.

Block macro format

To define a block macro in a GPD file, use the following format:

*BlockMacro: BlockMacroName {BlockMacroBody}

where BlockMacroName is a unique name, and BlockMacroBody is a set of one or more GPD file entries. If BlockMacroBody contains braces, equal numbers of left and right braces ( {, } ) must be included.

For example, you might define a block macro named EnvelopeDefaults, which is defined as follows:

*BlockMacro: EnvelopeDefaults
{
    *PrintableArea: PAIR(4646, 6738)
    *PrintableOrigin: PAIR(150, 150)
    *RotateSize: TRUE
}

Referencing block macros

To reference a block macro, use the following format:

*InsertBlock: =BlockMacroName

where BlockMacroName is a unique name, previously specified in the *BlockMacro entry that defines the macro.

For example, to reference the EnvelopeDefaults macro within an option specification, you could use the following entries:

*Option: Env9
{
    *InsertBlock: =EnvelopeDefaults
}