<< Click to Display Table of Contents >> VpeGetDevPaperBinID |
[Windows platform only; not supported by the Community Edition]
With this method you can retrieve all available paper bins of the currently selected output device. It returns the Bin-ID (see: VpeSetDevPaperBin) specified by "index" of the currently selected output device. The Bin-ID’s are numeric Windows system constants to identify a bin. This method only works correctly if you called VpeDevEnumPaperBins() before.
int VpeGetDevPaperBinID(
VpeHandle hDoc,
int index
)
VpeHandle hDoc
Document Handle
int index
must be in the range between 0 and the value returned by VpeDevEnumPaperBins() - 1
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 |
|
Additionally, each printer driver may define its own constants for other bins. Not all of the bin options are available on every printer. Check the printer's documentation for more specific descriptions of these options.
Remarks:
In case of an error, LastError is set to VERR_COMMON. This method works only correctly, if you called DevEnumPaperBins() before.
Example: