Specifications

No
EPSON
TITLE
EPSON Advanced Printer Driver for TM series
StatusAPI
Reference Manual
Revision
L
NEXT
89
SHEET
88
3.66.BiESCNClearImage
[Function]
Clear the registered Crop image.
[Format]
int BiESCNClearImage(int nHandle, BYTE bFlag, DWORD dwFileIndex,
LPSTR pFileID, LPSTR pImageTagData);
[Argument]
int nHandle
Select a printer handle value. Specify a return value of BiOpenMonPrinter() to the handle value.
BYTE bFlag
Select the flag for the method of clearing.
The Crop image to be cleared can be identified by a combination of flags.
CROP_CLEAR_ALL_IMAGE (0): Clear all the Crop image data saved.
CROP_ CLEAR_ BY_FILEINDEX(1):Clear all the Crop image data that have the values selected to
dwFileIndex.
CROP_ CLEAR_ BY_FILEID(2):Clear all the Crop image data that have the values selected to pFileID.
CROP_ CLEAR_ BY_IMAGETAGDATA(4):Clear all the Crop image data that have the values selected to
pImageTagData.
Example of selecting: When CROP_ CLEAR_ BY_FILEINDEX + CROP_ CLEAR_ BY_FILEID + CROP_
CLEAR_ BY_IMAGETAGDATA is selected to bFlag, all the Crop image data that match all the identification
data are cleared.
DWORD dwFileIndex
Select FileIndex, the identification data of the Crop image to be cleared.
LPSTR pFileID
Select FileID, the identification data of the Crop image to be cleared.
The symbols \ / : , ; * ? “ < > and | cannot be used.
LPSTR pImageTagData
Select ImageTagData, the identification data of the Crop image to be cleared.
The symbols \ / : , ; * ? “ < > and | cannot be used.
[Return value]
SUCCESS(0) is returned if the execution is successful. If an error occurs, one of the following error codes (negative value)
is returned:
ERR_HANDLE(-60) The handle value that selects the printer is incorrect.
ERR_PARAM(-90) Parameter error.
ERR_NOT_SUPPORT(-100) Not supported.
ERR_NOT_FOUND(-220) Selected data is not present.
[Explanation]
Clear the Crop image data that match the selected identification data from the saving table of Crop image data of statusAPI.
It is possible to clear all by selecting bFlag.
[Note]
The error (ERR_NOT_FOUND) is returned if the Crop image data that match the selected identification data are not
present.