4.3 WFS_CMD_CHK_READ

4.3 WFS_CMD_CHK_READ_IMAGE

Description

This function returns image data from the current check in TIFF 6.0 format.

Input Param

LPWFSCHKINREADIMAGE
typedef struct _wfs_in_read_image
     {
     WORD      hDoc;
     DWORD     dwOptions;
     LPSTR     lpszExtra;
     } WFSCHKINREADIMAGE, * LPWFSCHKINREADIMAGE;

hDoc

Handle to the check whose image is to be returned.

DwOptions

[No options have been defined as of this revision.]

lpszExtra

Points to a list of vendor-specific, or any other extended information. The information is returned as a series of “key=value” strings so that it is easily extensible by service providers. Each string is null-terminated, with the final string terminating with two null characters.

Output Param

LPWFSCHKOUTREADIMAGE
struct wfs_out_read_image
     {
     WORD      cbImage;
     LPSTR     lpImage;
     } WFSCHKOUTREADIMAGE, * LPWFSCHKOUTREADIMAGE;

cbImage

Count of bytes of image data.

lpImage

Points to the image data.

Error Code

The following additional error codes can be generated by this command:

Value	Meaning
WFS_ERR_CHK _INVALIDHDOC	hDoc is required but the value input does not correspond to a previously read document.
WFS_ERR_CHK _IMAGENOTAVAIL	The check referred to by hDoc does not have an image available.

Execute Events

None.

Comments.

Applications which require or expect specific information to be present in the lpszExtra parameter may not be device or vendor-independent.