Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 4.45 KB

nf-wiamindr_lh-iwiaminidrvcallback-minidrvcallback.md

File metadata and controls

107 lines (80 loc) · 4.45 KB
UID title description tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:wiamindr_lh.IWiaMiniDrvCallBack.MiniDrvCallback
IWiaMiniDrvCallBack::MiniDrvCallback (wiamindr_lh.h)
The MiniDrvCallback method provides a callback method for WIA minidrivers to use during a callback data transfer.
image
07/21/2022
IWiaMiniDrvCallBack::MiniDrvCallback
CallBack_ab4a8e02-c505-49d4-8933-27428333a00d.xml, IWiaMiniDrvCallBack interface [Imaging Devices],MiniDrvCallback method, IWiaMiniDrvCallBack.MiniDrvCallback, IWiaMiniDrvCallBack::MiniDrvCallback, MiniDrvCallback, MiniDrvCallback method [Imaging Devices], MiniDrvCallback method [Imaging Devices],IWiaMiniDrvCallBack interface, image.iwiaminidrvcallback_minidrvcallback, wiamindr_lh/IWiaMiniDrvCallBack::MiniDrvCallback
wiamindr_lh.h
Wiamindr.h
Desktop
Windows
IWiaMiniDrvCallBack::MiniDrvCallback
wiamindr_lh/IWiaMiniDrvCallBack::MiniDrvCallback
APIRef
kbSyntax
COM
wiamindr_lh.h
IWiaMiniDrvCallBack::MiniDrvCallback

-description

The MiniDrvCallback method provides a callback method for WIA minidrivers to use during a callback data transfer.

-parameters

-param lReason [in]

Specifies a constant value that designates a callback status message. This value is used to determine the purpose of the callback, and can be one of the following values:

Message Definition
IT_MSG_DATA Indicates that the transfer buffer contains a block of data.
IT_MSG_DATA_HEADER Received before any data transfers. Indicates that the transfer buffer points to a WIA_DATA_CALLBACK_HEADER structure that defines elements of the data transfer.
IT_MSG_DEVICE_STATUS Callback contains only status information about the device.
IT_MSG_FILE_PREVIEW_DATA Indicates preview data is being transferred to the application.
IT_MSG_FILE_PREVIEW_DATA_HEADER Indicates a header is being transferred to the application, prior to the preview data being transferred.
IT_MSG_NEW_PAGE Indicates that the data transfer of a page is complete, and a new page is being sent.
IT_MSG_STATUS Callback contains only status information about the transfer.
IT_MSG_TERMINATION Indicates that the data transfer is complete.

-param lStatus [in]

Specifies the status of the transfer. This parameter is a bitwise OR of the following values:

Status Definition
IT_STATUS_TRANSFER_FROM_DEVICE Transferring data from device.
IT_STATUS_PROCESSING_DATA Device and/or minidriver are processing the data.
IT_STATUS_TRANSFER_TO_CLIENT Transferring data from the minidriver to the WIA service.

-param lPercentComplete [in]

Specifies the current percentage of data transferred.

-param lOffset [in]

Specifies the current offset (in bytes) into the transfer buffer from the beginning of the buffer.

-param lLength [in]

Specifies the number of bytes contained in the transfer.

-param pTranCtx [in]

Points to a MINIDRV_TRANSFER_CONTEXT structure containing the data transfer values.

-param lReserved [in]

Reserved. Set to zero.

-returns

If the method succeeds, it returns S_OK. If the callback is canceled by the client application, the method returns S_FALSE. If the method fails, it returns a standard COM error code.

-remarks

The percent complete values are sent directly from the driver. The WIA service does not adjust the values.

IT_MSG_FILE_PREVIEW_DATA_HEADER is for out-of-band-data. This allows the application doing a file transfer to display the banded data. This is useful for scroll-fed scanners that have an unknown length and no preview scan. The information reported in this message should be treated the same as IT_MSG_DATA_HEADER. If a driver supports this message, it can supply preview data during its file transfer.

-see-also

IWiaMiniDrvCallBack

MINIDRV_TRANSFER_CONTEXT