|
<< Click to Display Table of Contents >> GetDevPaperBinID |
  
|
|
<< Click to Display Table of Contents >> GetDevPaperBinID |
|
[Windows platform only; not supported by PHP and 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 DevPaperBin) 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 DevEnumPaperBins()before.
method PaperBin [long] VPE.GetDevPaperBinID(
long Index
)
long index
must be in the range between 0 and the value returned by DevEnumPaperBins() - 1
Returns:
the Bin-ID, possible values are:
ActiveX / VCL |
Value |
Enum |
Comment |
VBIN_UNTOUCHED |
0 |
Untouched |
|
VBIN_UPPER |
1 |
Upper |
|
VBIN_ONLYONE |
1 |
OnlyOne |
|
VBIN_LOWER |
2 |
Lower |
|
VBIN_MIDDLE |
3 |
Middle |
|
VBIN_MANUAL |
4 |
Manual |
|
VBIN_ENVELOPE |
5 |
Envelope |
|
VBIN_ENVMANUAL |
6 |
EnvelopeManual |
|
VBIN_AUTO |
7 |
Auto |
|
VBIN_TRACTOR |
8 |
Tractor |
|
VBIN_SMALLFMT |
9 |
SmallFormat |
|
VBIN_LARGEFMT |
10 |
LargeFormat |
|
VBIN_LARGECAPACITY |
11 |
LargeCapacity |
|
VBIN_CASSETTE |
14 |
Cassette |
|
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 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:
see DevPaperBin