Specifications

No
EPSON
TITLE
EPSON Advanced Printer Driver for TM series
StatusAPI
Reference Manual
Revision
L
NEXT
53
SHEET
52
3.35.BiSCNSetScanArea
[Function]
Sets the image scanning area. Furthermore, the values set with this function remain in effect until the printer’s power is turned
off or until the printer is reset.
[Format]
int BiSCNSetScanArea( int nHandle, BYTE bStartX, BYTE bStartY, BYTE bEndX, BYTE bEndY)
[Argument]
int nHandle
Specifies the handle value of the printer executing the function. The return value in BiOpenMonPrinter() is specified.
BYTE bStartX
Specifies the starting X coordinate of the scanning area. The valid specification range is 0~254 in mm units.
(The valid specification range in the TM-H6000II is 0~99.)
The default value after the printer’s power is turned off or after printer reset is 0.
BYTE bStartY
Specifies the starting Y coordinate of the scanning area.
The valid specification range is 0~254 in mm units. The default value after the printer’s power is turned off or after
printer reset is 0.
BYTE bEndX
Specifies the ending X coordinate of the scanning area. The valid specification range is 0~255 in mm units.
(The valid specification range in the TM-H6000II is 0~100.)
If 0 is specified, that model’s maximum value is used.
The default value after the printer’s power is turned off or after printer reset is 70.
BYTE bEndY
Specifies the ending Y coordinate of the scanning area. The valid specification range is 0~255 in mm units.
If 0 is specified, that model’s maximum value is used.
The default value after the printer’s power is turned off or after printer reset is 0.
[Return Values]
If execution is successful, 0 is returned. If an error occurs, the following error codes (negative values) are returned.
ERR_HANDLE The handle value specified for the printer is incorrect.
ERR_PARAM
Parameter error
ERR_NOT_SUPPORT Not supported
ERR_ACCESS Reading/writing with the printer is not possible (printing in progress).
ERR_OFFLINE It was opened in the offline state, so it cannot be used until the online state is recovered.
[Caution]
If this function is executed for the TM-H6000II, which is not equipped with a scanner, it ends normally, but the scan
area is not set.
The coordinate reference point (0, 0) is the top right when facing toward the check paper insertion direction.
If bStartX > = bEndX, or bStartY > = bEndY (bEndY is not 0), it results in a parameter error.
If a bEndX, bEndY which exceeds the printer’s scannable area is specified, the values for the printer’s maximum
scannable area are set.
The maximum value that can be set may differ depending on the printer model with built-in scanner. Therefore, in the
StatusAPI, a check of the scanning area values is not conducted for every model. As a result, the specified value is
transmitted as is to the printer and operation is according to the command interpretation specifications of each printer.
Example: If the end X coordinate 101 is specified for the scanning area of the H6000II, (The original valid
specification range is 0 ~ 100.)
1) The API transmits 101 as the scanning area’s end X coordinate to the printer.
2) The printer regards the value as having exceeded the scannable area and sets the value to the maximum value 100.
[Supported Printers]
TM-H6000II with scanner