VpeGetDevPaperBin

<< Click to Display Table of Contents >>

Navigation:  Device Control Properties >

VpeGetDevPaperBin

Previous pageReturn to chapter overviewNext page

[Windows platform only; not supported by the Community Edition]

Retrieves the current selected paper bin of the currently selected output device.

int VpeGetDevPaperBin(

VpeHandle hDoc

)

VpeHandle hDoc

Document Handle

Returns:

the Bin-ID, possible values are:

Constant Name

Value

Comment

VBIN_UNTOUCHED

0

 

VBIN_UPPER

1

 

VBIN_ONLYONE

1

 

VBIN_LOWER

2

 

VBIN_MIDDLE

3

 

VBIN_MANUAL

4

 

VBIN_ENVELOPE

5

 

VBIN_ENVMANUAL

6

 

VBIN_AUTO

7

 

VBIN_TRACTOR

8

 

VBIN_SMALLFMT

9

 

VBIN_LARGEFMT

10

 

VBIN_LARGECAPACITY

11

 

VBIN_CASSETTE

14

 

False

0

failure

 

Additionally, each printer driver may define its own constants for other bins (see Remarks).

Remarks:

In case of an error, LastError is set to VERR_COMMON.

 

The Bin-ID’s are numeric Windows system constants to identify a bin. Additionally each printer driver may define its own constants for other bins. To retrieve a Bin-ID defined by a printer driver, enumerate all bins with VpeDevEnumPaperBins() and retrieve each Bin-ID associated with a Bin-Entry with VpeGetDevPaperBinID().