IWiaImageFilter::FilterPreviewImage method

The IWiaImageFilter::FilterPreviewImage method is called by the WIA Preview component, when an application calls the IWiaPreview::UpdatePreview method.

Syntax

HRESULT FilterPreviewImage(
  LONG      lFlags,
  IWiaItem2 *pWiaChildItem2,
  RECT      InputImageExtents,
  IStream   *pInputStream
);

Parameters

lFlags

pWiaChildItem2

Pointer to the item that the image process is to process. This item must be a child item of the item specified in the pWiaItem2 parameter, which was passed into the IWiaImageFilter::InitializeFilter method.

InputImageExtents

Structure that contains the upper-left and lower-right coordinates of a rectangle that represents the boundaries of the preview image on the flatbed's platen. This is also the coordinates for the image data that is passed into the pInputStream parameter .

pInputStream

Pointer to the IStream preview image.

Return value

Returns S_OK on success, or a standard COM error code on failure.

Remarks

This method cannot be invoked directly by the application.

The IStream and IWiaPreview interfaces are described in the Microsoft Windows SDK documentation.

Requirements

   
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header wia_lh.h (include Wia_lh.h)