IWiaMiniDrvTransferCallback::SendMessage method (wiamindr_lh.h)

Periodically called by the WIA mini-driver during a data transfer, to update the WIA application client about the progress and status of the transfer.

For more information about the progress data that is transferred, see WiaTransferParams.

Syntax

HRESULT SendMessage(
  [in] LONG              lFlags,
  [in] WiaTransferParams *pWiaTransferParams
);

Parameters

[in] lFlags

Represents flag bits. This parameter is unused and should always be set to zero (0) by the caller.

[in] pWiaTransferParams

Pointer to a WiaTransferParams object.

Return value

This method returns S_OK when the call is successful. Otherwise it returns an appropriate HRESULT error code.

Remarks

When the current transfer sequence is cancelled, the SendMessage method returns S_FALSE.

Requirements

Requirement Value
Minimum supported client Windows 8
Target Platform Desktop
Header wiamindr_lh.h

See also

Cancellation of Data Transfers

IWiaMiniDrvTransferCallback

WiaTransferParams