Specifications

No
EPSON
TITLE
EPSON Advanced Printer Driver for TM series
StatusAPI
Reference Manual
Revision
L
NEXT
87
SHEET
86
3.65.BiESCNRetrieveImage
[Function]
Acquire Crop image.
[Format]
int BiESCNRetrieveImage(int nHandle, DWORD dwFileIndex, LPSTR pFileID,
LPSTR pImageTagData, LPDWORD pImageSize, LPBYTE pImageData);
[Argument]
int nHandle
Select a printer handle value. Specify a return value of BiOpenMonPrinter() to the handle value.
DWORD dwFileIndex
Select FileIndex that is identification data of the Crop image to be acquired.
If NULL is selected, searching is not executed with this identification data.
LPSTR pFileID
Select FileID that is identification data of the Crop image to be acquired.
If NULL is selected, searching is not executed with this identification data. The symbols \ / : , ; * ? “ < > and |
cannot be used.
LPSTR pImageTagData
Select ImageTagData that is identification data of the Crop image to be acquired.
If NULL is selected, searching is not executed with this identification data. The symbols \ / : , ; * ? “ < > and |
cannot be used.
LPWORD pImageSize
Select memory size that sets Crop image data. After executing this argument, the actual CROP image data size is
set. If buffer capacity is not enough, necessary bytes are set; however, in the other error cases or if data is not
present, nothing is set.
LPBYTE pImageData
Select a memory address that sets Crop image data.
[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_BUFFER_OVER_FLOW(-140) Lack of buffer capacity.
ERR_NOT_FOUND(-220) Selected data is not present.
ERR_IMAGE_FILEOPEN(-230) Failure in opening image data file
ERR_IMAGE_FILEREAD(-290) Failure in reading image data file.
[Explanation]
Acquire Crop image data that match the selected identification data from Crop image save table of statusAPI.
[Note]
If NULL is selected for all identification data, the error (ERR_PARAM) is returned.
If Crop image data that match identification data selected are not present, the error (ERR_NOT_FOUND) is returned.