PrtInfo Function |  |
-- todo --
Returns the current specified printer setting.
Namespace:
XSharp.VFP
Assembly:
XSharp.VFP (in XSharp.VFP.dll) Version: 2.21
Syntax FUNCTION PrtInfo(
nPrinterSetting,
cPrinterName
) AS LONG CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public static int PrtInfo(
Usual nPrinterSetting = default,
Usual cPrinterName = default
)Parameters
- nPrinterSetting (Optional)
- Type: Usual
Specifies which X# printer setting to return. The table in the remarks section lists descriptions of the type of printer settings returned.
- cPrinterName (Optional)
- Type: Usual
Specifies the name of the printer for which information is returned. If cPrinterName is omitted, information is returned for the default printer.
Return Value
Type:
Long
Numeric data type. The following tables list values returned when specifying particular values for nPrinterSetting.
If nPrinterSetting is 1,
PrtInfo( ) returns the paper orientation as the following:
| Return values | Paper orientation |
|---|
| -1 | Information not available |
| 0 | Portrait |
| 1 | Landscape |
If nPrinterSetting is 2,
PrtInfo( ) returns the paper size as the following:
| Return values | Paper Size |
|---|
| –1 or value other than listed | Information not available. Use nPrinterSetting = 3 and nPrinterSetting = 4 to return the paper size. |
| 1 | Letter, 8 1/2 x 11 in |
| 2 | Letter Small, 8 1/2 x 11 in |
| 3 | Tabloid, 11 x 17 in |
| 4 | Ledger, 17 x 11 in |
| 5 | Legal, 8 1/2 x 14 in |
| 6 | Statement, 5 1/2 x 8 1/2 in |
| 7 | Executive, 7 1/4 x 10 1/2 in |
| 8 | A3, 297 x 420 mm |
| 9 | A4, 210 x 297 mm |
| 10 | A4, Small 210 x 297 mm |
| 11 | A5, 148 x 210 mm |
| 12 | B4, 250 x 354 mm |
| 13 | B5, 182 x 257 mm |
| 14 | Folio, 8 1/2 x 13 in |
| 15 | Quarto, 215 x 275 mm |
| 16 | 10 x 14 in |
| 17 | 11 x 17 in |
| 18 | Note, 8 1/2 x 11 in |
| 19 | Envelope #9, 3 7/8 x 8 7/8 in |
| 20 | Envelope #10, 4 1/8 x 9 1/2 in |
| 21 | Envelope #11, 4 1/2 x 10 3/8 in |
| 22 | Envelope #12, 4 1/2 x 11 in |
| 23 | Envelope #14, 5 x 11 1/2 in |
| 24 | C size sheet |
| 25 | D size sheet |
| 26 | E size sheet |
| 27 | Envelope DL, 110 x 220 mm |
| 28 | Envelope C5, 162 x 229 mm |
| 29 | Envelope C3, 324 x 458 mm |
| 30 | Envelope C4, 229 x 324 mm |
| 31 | Envelope C6, 114 x 162 mm |
| 32 | Envelope C65, 114 x 229 mm |
| 33 | Envelope B4, 250 x 353 mm |
| 34 | Envelope B5, 176 x 250 mm |
| 35 | Envelope B6, 176 x 125 mm |
| 36 | Envelope, 110 x 230 mm |
| 37 | Envelope Monarch, 3 7/8 x 7.5 in |
| 38 | 6 3/4 Envelope, 3 5/8 x 6 1/2 in |
| 39 | US Std Fanfold, 14 7/8 x 11 in |
| 40 | German Std Fanfold, 8 1/2 x 12 in |
| 41 | German Legal Fanfold, 8 1/2 x 13 in |
If nPrinterSetting is 7,
PrtInfo( ) returns the default paper source as the following:
| Return values | Default paper source |
|---|
| 1 | Upper bin |
| 2 | Lower bin |
| 3 | Middle bin |
| 4 | Manual feed |
| 5 | Envelope bin |
| 6 | Manual feed envelope |
| 7 | Automatic feed |
| 8 | Tractor feed |
| 9 | Small format |
| 10 | Large format |
| 11 | Large capacity |
| 14 | Cassette |
| 15 | Default input bin (automatically select) |
If nPrinterSetting is 8 and
PrtInfo( ) returns a negative value, the return value indicates the print quality as the following:
| Return values | Print quality |
|---|
| -1 | Draft |
| –2 | Low |
| –3 | Medium |
| –4 | High |
If nPrinterSetting is 9,
PrtInfo( ) returns a value indicating if a color printer renders color or monochrome output as the following:
| Return values | Color of output |
|---|
| 1 | Monochrome |
| 2 | Color |
If nPrinterSetting is 10,
PrtInfo( ) returns the duplex mode as the following:
| Return values | Duplex mode |
|---|
| 1 | Simplex printing |
| 2 | Vertical duplex |
| 3 | Horizontal duplex |
If nPrinterSetting is 12,
PrtInfo( ) returns a value that indicates how TrueType® fonts are printed as the following:
| Return values | Printing of TrueType® fonts |
|---|
| 1 | Print as bitmapped graphics |
| 2 | Download as soft fonts |
| 3 | Substitute device fonts |
If nPrinterSetting is 13,
PrtInfo( ) returns a value that indicates if output is collated as the following:
| Return values | Collation |
|---|
| 0 | No collation |
| 1 | Collated |
Remarks
You can set X# printer settings in the printer Page Setup dialog box. For more information, see Page Setup Dialog Box.
| nPrinterSetting | XSHARP.H | Setting returned |
|---|
| 1 | PRT_ORIENTATION | Paper orientation |
| 2 | PRT_PAPERSIZE | Paper size |
| 3 | PRT_PAPERLENGTH | Paper length in .1 millimeter increments |
| 4 | PRT_PAPERWIDTH | Paper width in .1 millimeter increments |
| 5 | PRT_SCALE | Factor by which printer output is scaled |
| 6 | PRT_COPIES | Number of copies to print |
| 7 | PRT_DEFASOURCE | Default paper source |
| 8 | PRT_PRINTQUAL | A positive value that indicates the horizontal resolution in dots per inch (DPI) or a negative value that indicates the print quality. |
| 9 | PRT_COLOR | A value that indicates if a color printer rends color or monochrome output |
| 10 | PRT_DUPLEX | Duplex mode |
| 11 | PRT_YRESOLUTION | The vertical resolution in dots per inch (DPI). If not available, a value of -1 is returned. |
| 12 | PRT_TTOPTION | A value that indicates how TrueType® fonts are printed |
| 13 | PRT_COLLATE | A value that indicates if output is collated |
See Also 
