This function is used to enumerate the PaperSrcName (printer tray) + PaperSrcValue (associated internal value) combinations for a given printer.
Context
Windows client,
Adelia Cloud client,
Event Adelia client.
Parameters
ALPHA |
PrinterName |
Name of the printer whose paper trays are to be listed. |
NUM_BIN_4 |
PaperSrcValue |
Value assigned to the tray. |
ALPHA |
PaperSrcName |
Paper tray name. |
NUM_BIN_2 |
PaperSrcNameLg |
Size of the PaperSrcName buffer. |
NUM_BIN_2 |
PaperSrcNum |
Increment number in the list. |
BOOL |
ReturnCode |
Return code for the operation: *TRUE if the operation was successful. *FALSE if the operation failed. |
Note: The first time this function is called, PaperSrcNum must be set to 0. This parameter must then be incremented by 1 before each new call, until the ReturnCode returns *FALSE. In addition, the VatoolBx DLL must remain loaded until the end of the enumeration.
Example
PrinterName = '\\PRTSRV\PRINTER1'
PaperSrcNum = 0
LOAD_DLL 'VaToolBx'
CALL_DLL 'VaToolBx.Dll' 'VaToolBxEnumPrinterPaperSource' PrinterName PaperSrcValue PaperSrcName PaperSrcNameLg PaperSrcNum ReturnCode
DO_WHILE ReturnCode = *TRUE
/* PaperSrcValue and PaperSrcName specified
PaperSrcNum = PaperSrcNum + 1
CALL_DLL 'VaToolBx.Dll' 'VaToolBxEnumPrinterPaperSource' PrinterName PaperSrcValue PaperSrcName
PaperSrcNameLg PaperSrcNum ReturnCode
REDO
UNLOAD_DLL 'VaToolBx'
List of the VaToolBx functions by topic