SetPixelWindow function (wiamicro.h)

Article
02/22/2024

The SetPixelWindow function sets the image area to be scanned.

Syntax

WIAMICRO_API HRESULT SetPixelWindow(
  [in, out] PSCANINFO pScanInfo,
            LONG      x,
            LONG      y,
            LONG      xExtent,
            LONG      yExtent
);

Parameters

[in, out] pScanInfo

Points to a SCANINFO structure that represents the current state of the device. This is stored by the WIA Flatbed driver to guarantee synchronized settings between the microdriver and the WIA Flatbed driver.

x

Specifies the horizontal position value for the left side of the selection rectangle in pixels.

y

Specifies the vertical position value for the top of the selection rectangle in pixels.

xExtent

Specifies the width of the selection rectangle in pixels.

yExtent

Specifies the height of the selection rectangle in pixels.

Return value

If the function succeeds, it returns S_OK. If the function fails, it returns a standard COM error code.

Remarks

In this function, the microdriver should set up the Window member of the SCANINFO structure, making any device-specific adjustments that are necessary.

Requirements

Requirement	Value
Target Platform	Desktop
Header	wiamicro.h (include Wiamicro.h)