PC_PRINTER_LOAD_BMP

Restriction:
  • This routine is not supported on UNIX platforms.
  • This routine is not supported when CHARSET"EBCDIC" is in effect.
Loads a bitmap or other supported file format into memory ready for the PC_PRINTER_WRITE_BMP function.

Syntax:

call "PC_PRINTER_LOAD_BMP"  using        printer-handle
                           by reference bmpfilename
                           by reference bmp-id
                           returning    status-code

Parameters:

  Using call prototype (see Key) Picture
printer-handle cblt-x4-comp5 pic x(4) comp-5.
bmpfilename pic x(n). pic x(n).
bmp-id cblt-x4-comp5 pic x(4) comp-5.
status-code See Library Routines - Key

On Entry:

printer-handle
The printer handle returned when the printer was opened.
bmpfilename
The name of the bitmap or other supported file format to be loaded (the name should be terminated with a null or space).

On Exit:

bmp-id
A unique identifier for the loaded file.
status-code
Printer status code:
0 Successful
3 Printer device not open
18 Failed to load bitmap
19 Invalid bitmap identifier

Comments:

The following file formats are supported: BMP.

This routine is available only in the Windows environment.

Example:

call "PC_PRINTER_LOAD_BMP" using printer-handle
                             by reference "mflogo.bmp" & x"0"
                             by reference bmp-id
                           returning  printer-retcode.