Customization › Advanced Laser Printer Interface › $LPCMS

$LPCMS

The $LPCMS macro is used to define a command skeleton element. One command skeleton is composed of a number of skeleton elements. An invocation of $LPCMS with END=YES must be done after the last skeleton element. A command skeleton can be made up of fixed text alone, or fixed text mixed with variable data (to be inserted by the Laser interface).

An example of a fixed text only skeleton is the RESET command in the XDEVTYPE module. An example of a mixed skeleton is the ABSOLUTE POSITIONING command in the XDEVTYPS module. It has the two coordinates as variables.

$LPCMS BREAK=<YES | NO>,              
  CMDTYPE=<TEXT>,                 
          <NUM			>
          <X  			>
          <Y  			>
  DATA1='data1',                  
  DATA2='data2',                  
  DATA3='data3',                  
  DATA4='data4',                  
  DATA5='data5',                  
  DIV=<99 | 1>,                   
  END=<YES | NO>,                 
  DIV=<99 | 1>,                   
  TYPE1=<C | X>,                  
  TYPE2=<C | X>,                  
  TYPE3=<C | X>,                  
  TYPE4=<C | X>,                  
  TYPE5=<C | X>                   

$LPCMS Parameters

This section describes the &LPCMS parameters.

CMDTYPE=TEXT|NUM|X|Y

The parameter effects are:

• TEXT—(Default) Specifies text which is part of the element. At least one of the DATAn and TYPEn pairs must be specified.
• NUM—Specifies a variable numeric, which is inserted by the Laser interface.
• X—Specifies a variable X value, which is inserted by the Laser interface.
• Y—Specifies a variable Y value, which is inserted by the Laser interface.

DATAn

This parameter is the data part of the DC statement. Together with TYPEn, this parameter results in a DC statement, which is part of a TEXT type skeleton element. Quotes must be included. The default value is NONE.

DIV=99|1

If the units used for the numeric in this skeleton element are different from the units used for this device in general (sizes, offsets, spacing, and so on), the number inserted as a result of this skeleton element is multiplied by the value specified in the MULT parameter, and the result is divided by the value specified in this parameter.

This parameter is used only if CMDTYPE was specified as NUM, X, or Y.

The default value is 1.

END=YES|NO

The parameter effects are:

• YES—Ends the skeleton of this command. If END=YES is specified this must be the only parameter
• NO—(Default) This is a normal invocation of the macro.

KEEP=ON|OFF|NO

The parameter effects are:

• ON—Marks the start of a block, which the interface must keep within the same VTAM buffer if possible.
• OFF—Marks the end of a block, which the interface must keep within the same VTAM buffer if possible. If a block is bigger than 256 bytes, the interface might be unable to keep the data within one VTAM buffer.
• NO—(Default) Used for middle skeleton elements.

MULT

If the units used for the numeric in this skeleton element are different from the units used for this device in general (sizes, offsets, spacing, and so on), the number inserted as a result of this skeleton element is multiplied by the value specified in this parameter, and the result is divided by the value specified in the DIV parameter.

This parameter is used only if CMDTYPE is specified as NUM, X, or Y.

TYPEn

Together with DATAn this parameter results in a DC statement, which is part of a TEXT type skeleton element. This parameter is the type used in the DC statement.