IWiaDataTransfer::idtGetData-Methode (wia_xp.h)

  • Artikel

Die IWiaDataTransfer::idtGetData-Methode ruft vollständige Dateien von einem WiA-Gerät (Windows Image Acquisition) ab.

Syntax

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

Parameter

[in, out] pMedium

Typ: LPSTGMEDIUM

Zeiger auf die STGMEDIUM-Struktur .

[in] pIWiaDataCallback

Typ: IWiaDataCallback*

Zeiger auf die IWiaDataCallback-Schnittstelle .

Rückgabewert

Typ: HRESULT

Diese Methode kann einen der folgenden Werte zurückgeben:

Rückgabewert Bedeutung
E_INVALIDARG Mindestens ein Parameter für diese Methode enthält ungültige Daten.
E_OUTOFMEMORY Diese Methode kann nicht genügend Arbeitsspeicher zuweisen, um den Vorgang abzuschließen.
E_UNEXPECTED Unbekannter Fehler aufgetreten.
S_FALSE Die Anwendung hat den Vorgang abgebrochen.
S_OK Das Image wurde erfolgreich erfasst.
STG_E_MEDIUMFULL Das Speichermedium, das die Anwendung zum Abrufen des Images verwendet, ist voll.
WIA_S_NO_DEVICE_AVAILABLE Es sind keine WIA-Hardwaregeräte an den Computer des Benutzers angeschlossen.
 

Diese Methode gibt einen in Fehlercodes angegebenen Wert oder einen COM-Standardfehler zurück, wenn es aus einem anderen Grund als den in der vorherigen Tabelle angegebenen Grund fehlschlägt.

Hinweise

In den meisten Punkten funktioniert diese Methode identisch mit der IDataObject::GetData-Methode . Der Hauptunterschied besteht darin, dass IWiaData::idtGetData einen zusätzlichen Parameter für einen Zeiger auf die IWiaDataCallback-Schnittstelle bereitstellt. Anwendungen verwenden diesen optionalen Parameter, um status Benachrichtigungen während der Datenübertragung abzurufen. Wenn keine status Benachrichtigungen erforderlich sind, sollte sie auf Null festgelegt werden.

Das Format der Datenübertragung wird durch die Werte der WIA_IPA_FORMAT - und WIA_IPA_TYMED Eigenschaften des Elements bestimmt. Die Anwendung legt diese Eigenschaften mit Aufrufen der IWiaPropertyStorage::WriteMultiple-Methode fest.

Im Gegensatz zur IWiaDataTransfer::idtGetBandedData-Methode überträgt IWiaDataTransfer::idtGetData eine vollständige Datei von einem WIA-Gerät an eine Anwendung und nicht nur ein einzelnes Datenband. Der pMedium-Parameter ist ein Zeiger auf die STGMEDIUM-Struktur , die Informationen zum Speichermedium enthält, das für die Datenübertragung verwendet werden soll. Programme verwenden den pIWiaDataCallback-Parameter , um dieser Methode einen Zeiger auf die IWiaDataCallback-Schnittstelle zu übergeben. Diese Methode verwendet in regelmäßigen Abständen den Schnittstellenzeiger, um die BandedDataCallback-Methode aufzurufen und der Anwendung status Informationen zur laufenden Datenübertragung bereitzustellen.

Übergeben Sie NULL als Wert des lpszFileName-Members der pMedium-Struktur , damit WIA den Dateinamen und den Speicherort für die neue Datei bestimmen kann. Nach der Rückgabe enthält das lpszFileName-Element der pMedium-Struktur den Speicherort und den Namen der neuen Datei.

Wenn der von dieser Methode zurückgegebene Wert ein COM SUCCESS-Wert ist oder die Übertragung eine mehrseitige Dateiübertragung ist und der zurückgegebene Fehlercode WIA_ERROR_PAPER_JAM, WIA_ERROR_PAPER_EMPTY oder WIA_ERROR_PAPER_PROBLEM ist, löscht WIA die Datei nicht.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile wia_xp.h (einschließlich Wia.h)
Bibliothek Wiaguid.lib
DLL Wiaservc.dll