IWiaDataTransfer::idtGetData, méthode (wia_xp.h)

La méthode IWiaDataTransfer::idtGetData récupère des fichiers complets à partir d’un appareil WIA (Windows Image Acquisition).

Syntaxe

HRESULT idtGetData(
  [in, out] LPSTGMEDIUM      pMedium,
  [in]      IWiaDataCallback *pIWiaDataCallback
);

Paramètres

[in, out] pMedium

Type : LPSTGMEDIUM

Pointeur vers la structure STGMEDIUM .

[in] pIWiaDataCallback

Type : IWiaDataCallback*

Pointeur vers l’interface IWiaDataCallback .

Valeur retournée

Type : HRESULT

Cette méthode peut retourner l’une des valeurs suivantes :

Valeur renvoyée Signification
E_INVALIDARG Un ou plusieurs paramètres de cette méthode contiennent des données non valides.
E_OUTOFMEMORY Cette méthode ne peut pas allouer suffisamment de mémoire pour terminer son opération.
E_UNEXPECTED Une erreur inconnue s'est produite.
S_FALSE L’application a annulé l’opération.
S_OK L’image a été acquise avec succès.
STG_E_MEDIUMFULL Le support de stockage que l’application utilise pour acquérir l’image est complète.
WIA_S_NO_DEVICE_AVAILABLE Il n’existe aucun appareil matériel WIA attaché à l’ordinateur de l’utilisateur.
 

Cette méthode retourne une valeur spécifiée dans les codes d’erreur ou une erreur COM standard si elle échoue pour une raison autre que celles spécifiées dans le tableau précédent.

Notes

Dans la plupart des cas, cette méthode fonctionne de manière identique à la méthode IDataObject::GetData . La principale différence est que IWiaDataTransfer::idtGetData fournit un paramètre supplémentaire pour un pointeur vers l’interface IWiaDataCallback . Les applications utilisent ce paramètre facultatif pour obtenir des notifications d’état pendant le transfert de données. Si aucune notification d’état n’est nécessaire, elle doit être définie sur zéro.

Le format du transfert de données est déterminé par les valeurs des propriétés WIA_IPA_FORMAT et WIA_IPA_TYMED de l’élément. L’application définit ces propriétés avec des appels à la méthode IWiaPropertyStorage::WriteMultiple .

Contrairement à la méthode IWiaDataTransfer::idtGetBandedData , IWiaDataTransfer::idtGetData transfère un fichier complet d’un appareil WIA à une application plutôt qu’à une seule bande de données. Le paramètre pMedium est un pointeur vers la structure STGMEDIUM qui contient des informations sur le support de stockage à utiliser pour le transfert de données. Les programmes utilisent le paramètre pIWiaDataCallback pour transmettre cette méthode à un pointeur vers l’interface IWiaDataCallback . Régulièrement, cette méthode utilise le pointeur d’interface pour appeler la méthode BandedDataCallback et fournir à l’application des informations d’état sur le transfert de données en cours.

Passez NULL comme valeur du membre lpszFileName de la structure pMedium pour permettre à WIA de déterminer le nom et l’emplacement du fichier pour le nouveau fichier. Au retour, le membre lpszFileName de la structure pMedium contient l’emplacement et le nom du nouveau fichier.

Si la valeur retournée par cette méthode est une valeur COM SUCCESS ou si le transfert est un transfert de fichiers multipage et que le code d’erreur retourné est WIA_ERROR_PAPER_JAM, WIA_ERROR_PAPER_EMPTY ou WIA_ERROR_PAPER_PROBLEM, WIA ne supprime pas le fichier.

Configuration requise

   
Client minimal pris en charge Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête wia_xp.h (inclure Wia.h)
Bibliothèque Wiaguid.lib
DLL Wiaservc.dll