Méthode IWiaMiniDrvCallBack ::MiniDrvCallback (wiamindr_lh.h)

Article
08/08/2023

La méthode MiniDrvCallback fournit une méthode de rappel pour les minidrivers WIA à utiliser lors d’un transfert de données de rappel.

Syntaxe

HRESULT MiniDrvCallback(
  [in] LONG                      lReason,
  [in] LONG                      lStatus,
  [in] LONG                      lPercentComplete,
  [in] LONG                      lOffset,
  [in] LONG                      lLength,
  [in] PMINIDRV_TRANSFER_CONTEXT pTranCtx,
  [in] LONG                      lReserved
);

Paramètres

[in] lReason

Spécifie une valeur constante qui désigne un rappel status message. Cette valeur est utilisée pour déterminer l’objectif du rappel et peut être l’une des valeurs suivantes :

Message	Définition
IT_MSG_DATA	Indique que la mémoire tampon de transfert contient un bloc de données.
IT_MSG_DATA_HEADER	Reçu avant tout transfert de données. Indique que la mémoire tampon de transfert pointe vers une structure WIA_DATA_CALLBACK_HEADER qui définit les éléments du transfert de données.
IT_MSG_DEVICE_STATUS	Le rappel contient uniquement status informations sur l’appareil.
IT_MSG_FILE_PREVIEW_DATA	Indique que les données d’aperçu sont en cours de transfert vers l’application.
IT_MSG_FILE_PREVIEW_DATA_HEADER	Indique qu’un en-tête est en cours de transfert vers l’application, avant le transfert des données d’aperçu.
IT_MSG_NEW_PAGE	Indique que le transfert de données d’une page est terminé et qu’une nouvelle page est envoyée.
IT_MSG_STATUS	Le rappel contient uniquement status informations sur le transfert.
IT_MSG_TERMINATION	Indique que le transfert de données est terminé.

[in] lStatus

Spécifie la status du transfert. Ce paramètre est un OR au niveau du bit des valeurs suivantes :

Statut	Définition
IT_STATUS_TRANSFER_FROM_DEVICE	Transfert de données à partir de l’appareil.
IT_STATUS_PROCESSING_DATA	L’appareil et/ou le minidriver traitent les données.
IT_STATUS_TRANSFER_TO_CLIENT	Transfert de données du minidriver vers le service WIA.

[in] lPercentComplete

Spécifie le pourcentage actuel de données transférées.

[in] lOffset

Spécifie le décalage actuel (en octets) dans la mémoire tampon de transfert à partir du début de la mémoire tampon.

[in] lLength

Spécifie le nombre d’octets contenus dans le transfert.

[in] pTranCtx

Pointe vers une structure MINIDRV_TRANSFER_CONTEXT contenant les valeurs de transfert de données.

[in] lReserved

Réservé. Définit la valeur zéro.

Valeur retournée

Si la méthode réussit, elle retourne S_OK. Si le rappel est annulé par l’application cliente, la méthode retourne S_FALSE. Si la méthode échoue, elle retourne un code d’erreur COM standard.

Remarques

Les valeurs de pourcentage d’achèvement sont envoyées directement à partir du pilote. Le service WIA n’ajuste pas les valeurs.

IT_MSG_FILE_PREVIEW_DATA_HEADER concerne les données hors bande. Cela permet à l’application effectuant un transfert de fichiers d’afficher les données en bandes. Cela est utile pour les scanneurs à défilement qui ont une longueur inconnue et aucune analyse d’aperçu. Les informations signalées dans ce message doivent être traitées comme IT_MSG_DATA_HEADER. Si un pilote prend en charge ce message, il peut fournir des données d’aperçu pendant son transfert de fichiers.

Configuration requise

Condition requise	Valeur
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	wiamindr_lh.h (inclure Wiamindr.h)

Voir aussi

IWiaMiniDrvCallBack

MINIDRV_TRANSFER_CONTEXT

Partager via