isCOBOL Evolve : Appendices : Library Routines : WIN$PRINTER : WINPRINT-PRINT-BITMAP
WINPRINT-PRINT-BITMAP
The WINPRINT-PRINT-BITMAP function prints an image.
If you need to print text over the bitmap, do it after this call. If you do it before, the bitmap covers the text.
Syntax:
 CALL "WIN$PRINTER" USING WINPRINT-PRINT-BITMAP 
                          WINPRINT-DATA
                   GIVING returnCode
Parameters:
WINPRINT-PRINT-BITMAP
Constant
 
WINPRINT-DATA
Group Item
Structure that contains the information to be passed to the function. This group item, defined in isprint.def, has the following structure:
 
01  winprint-data.
    03 wprtdata-print-bitmap.
       05 wprtdata-bitmap           pic x(4) comp-n.
       05 wprtdata-bitmap-row       pic 9(7)v99 comp-5.
       05 wprtdata-bitmap-col       pic 9(7)v99 comp-5.
       05 wprtdata-bitmap-height    pic 9(7)v99 comp-5.
       05 wprtdata-bitmap-width     pic 9(7)v99 comp-5.
       05 wprtdata-bitmap-flags     unsigned-short.
wprtdata-bitmap
Specifies the handle of the bitmap to be printed.
Do not destroy this handle before closing the print file.
wprtdata-bitmap-row
Specifies the vertical coordinate of top-left corner of the bitmap, in cells. The position refers to the physical left margin.
wprtdata-bitmap-col
Specifies the horizontal coordinate of top-left corner of the bitmap, in cells. The position refers to the physical left margin.
wprtdata-bitmap-height
Specifies the height of the printed image. If this member is zero, the height is automatically calculated so that the aspect ratio is kept.
wprtdata-bitmap-width
Specifies the width of the printed image. If this member is zero, the width is automatically calculated so that the aspect ratio is kept.
wprtdata-bitmap-flags
Specifies the units of measure for location (wprtdata-bitmap-row and wprtdata-bitmap-col) and dimensions (wprtdata-bitmap-width and wprtdata-bitmap-height) of the bitmap. The value is the sum of location unit and scale unit.
 
Scale unit can be one of the following:
0
Values are expressed in cells.
WPRTBITMAP-SCALE-CELLS
Values are expressed in cells.
WPRTBITMAP-SCALE-INCHES
Values are expressed in inches.
WPRTBITMAP-SCALE-CENTIMETERS
Values are expressed in centimeters.
WPRTBITMAP-SCALE-PIXELS
Values are expressed in pixels.
Location unit can be one of the following:
0
Values are expressed in cells.
WPRTBITMAP-UNITS-INCHES
Values are expressed in inches.
WPRTBITMAP-UNITS-CENTIMETERS
Values are expressed in centimeters.
WPRTBITMAP-UNITS-PIXELS
Values are expressed in pixels.
To inform the runtime that the bitmap was designed directly for printing on the current printer and should not be scaled, set WPRTDATA-BITMAP-FLAGS to WPRTBITMAP-PRINTER-BITMAP.
Return code:
returnCode can be any signed numeric data item and provides additional information:
1
Operation successful.
WPRTERR-UNSUPPORTED
The WIN$PRINTER library routine is not supported.
WPRTERR-BAD-ARG
The WIN$PRINTER library routine has been called with bad parameters.