Description
The Get_Printer function returns a printer property, based on the parameter passed to it.
Syntax
retValue = Get_Printer(msg)
Parameters
The only parameter that is passed to Get_Printer is the message.. The parameter delimiter for Get_Printer is @FM, and all other delimiters are shifted down. Therefore, the delimiters for each parameter are shifted from @FM to @VM and from @VM to @SVM.
Returns
The return value is the value for the printer property that you requested with the MSG parameter. The format of the return value is the same as the parameters that are used by Set_Printer, but you should check the format of each Set_Printer message.
See also
Example
See Appendix C: Advanced Topics.
| Message | Description |
|---|---|
| ARCHIVE | The ARCHIVE message returns information regarding reports that have been archived using the OIPI Archive export type |
| CALCBMP | The CALCBMP message is used to calculate the width and height of a bitmap before printing. Use the Get_Printer CALCBMP message to retrieve the width and height of the bitmap after setting the bitmap with the CALCBMP message. |
| CALCMAXLEN | The CALMAXLEN message returns the maximum number of characters that fit within the specified size from the last call to the CALCMAXLEN Set_Printer() message. |
| CALCTABLE | The CALCTABLE message returns the width and height for the table that was set with the last call to the CALCTABLE Set_Printer() message. |
| CALCTEXT | The CALCTEXT message returns the width and height for the text that was set with the last call to the CALCTEXT Set_Printer() message. |
| CANCEL | The CANCEL message returns the status of the print session. |
| CONTROL | The CONTROL message returns the control information set during the CONTROL Set_Printer() message. |
| COPIES | The COPIES message returns the number of copies to be printed. |
| CURRENTDEVICE | The CURRENTDEVICE message returns the current printer device information. |
| CURRENTDRIVER | The CURRENTDRIVER message returns the current printer driver information. |
| CURRENTPORT | The CURRENTPORT message returns the current printer port information. |
| DEVICES | The DEVICES message returns all of the printer devices. |
| DPI | The DPI message returns the Dots-Per-Inch for the current printer. |
| DUPLEX | The DUPLEX message returns the current duplex setting for the printer. See the OIPRINT_EQUATES for the Duplex values. |
| FILLSTYLE | The FILLSTYLE message returns information about the current fill style settings. |
| FONT | The FONT message returns information about the current font used to print text. |
| FONTHEADFOOT | The FONTHEADFOOT message returns information about the font used to print headers and footers. |
| FOOTER | The FOOTER message returns information about the page footer. |
| HDC | The HDC message returns the handle for the current printer. This handle can be used to print output to the current printer outside of the OIPI. |
| HEADER | The HEADER message returns the information about the page header. |
| INDENT | The INDENT message returns information about the current indent. |
| INIT | The INIT message returns information set in the INIT Set_Printer message. |
| LINESTYLE | The LINESTYLE message returns information about the current line style settings. |
| MARGIN | The MARGIN message returns the margin settings. |
| ORIENTATION | The ORIENTATION message returns the orientation of the current printer. |
| PAGE | The PAGE message returns the current page number. |
| PAGESIZE | The PAGESIZE message returns the width and height of the page. |
| PAGESIZES | The PAGESIZES message returns the available page sizes for the current printer. |
| PAPERBIN | The PAPERBIN message returns the current Paper Bin. See the OIPRINT_EQUATES for the Paper Bin values. |
| PAPERBINS | The PAPERBINS message returns all of the available Paper Bins. See the OIPRINT_EQUATES for the Paper Bin values. |
| PORTS | The PORTS message returns the available ports for the current printer. |
| POS | The POS message returns the current X and Y positions of the page. |
| PREVIEWMODE | The PREVIEWMODE message returns the Preview Mode setting. |
| PRINTERINFO | The PRINTERINFO message returns information about the default printer. This information is retrieved with the WinAPI function GetDeviceCaps. See a WinAPI reference manual for more details on the return information from the PRINTERINFO message. |
| PRINTQUALITY | The PRINTQUALITY message returns the Print Quality setting of the printer. |
| SERIAL | The SERIAL message returns the OpenInsight Printer Interface serial number as a string. |
| SUPPORTCOPIES | If the current printer supports printing multiple Copies, then the SUPPORTCOPIES message will return 1 otherwise, it will return -17. |
| TRUETYPE | The TRUETYPE message returns the True Type setting of the printer. |
| VERSION | The VERSION message returns the current OpenInsight Printer Interface version number as a string. |
