7.7 WFS_CMD_PTR_READ_IMAGE

Description This function returns image data from the current media. If no media is present, the device waits for the period of time specified by the dwTimeOut parameter in the WFSExecute call for media to be inserted.

Input Param None.

Output Param LPWFSPTRIMAGE lpImage;

 typedef struct _wfs_ptr_image
  {
  WORD wImageType;
  ULONG ulSize;
  LPBYTE lpImage;
  } WFSPTRIMAGE, * LPWFSPTRIMAGE;

wImageType
Specifies the format of the image returned by this command as one of the following flags:

Value Meaning

WFS_PTR_IMAGETIF The returned image is in TIF format.

WFS_PTR_IMAGEMTF The returned image is in MTF format.

WFS_PTR_IMAGEBMP The returned image is in BMP format.

ulSize
Count of bytes of image data.

lpImage
Points to the image data.

Error Code There are no additional error codes generated by this command.

Events The following additional events can be generated by this command:

Value Meaning

WFS_EXEE_PTR_NOMEDIA No media is present in the device.

WFS_EXEE_PTR_MEDIAINSERTED Media has been inserted into the device.

Comments None.