次の方法で共有

IWiaDataTransfer::idtGetData メソッド (wia_xp.h)

  • [アーティクル]

IWiaDataTransfer::idtGetData メソッドは、Windows イメージ取得 (WIA) デバイスから完全なファイルを取得します。

構文

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

パラメーター

[in, out] pMedium

種類: LPSTGMEDIUM

STGMEDIUM 構造体へのポインター。

[in] pIWiaDataCallback

種類: IWiaDataCallback*

IWiaDataCallback インターフェイスへのポインター。

戻り値

種類: HRESULT

このメソッドは、次のいずれかの値を返すことができます。

戻り値 説明
E_INVALIDARG このメソッドの 1 つ以上のパラメーターに無効なデータが含まれています。
E_OUTOFMEMORY このメソッドは、操作を完了するのに十分なメモリを割り当てることができません。
E_UNEXPECTED 原因不明のエラーが発生しました。
S_FALSE アプリケーションによって操作が取り消されました。
S_OK イメージが正常に取得されました。
STG_E_MEDIUMFULL アプリケーションがイメージを取得するために使用しているストレージ メディアがいっぱいです。
WIA_S_NO_DEVICE_AVAILABLE ユーザーのコンピューターに WIA ハードウェア デバイスが接続されていません。
 

このメソッドは、 エラー コードで指定された値を返します。前の表で指定した値以外の理由でエラーが発生した場合は、標準 COM エラーが返されます。

解説

ほとんどの点で、このメソッドは IDataObject::GetData メソッドと同じように動作します。 主な違いは、 IWiaDataTransfer::idtGetData が IWiaDataCallback インターフェイスへのポインターに追加のパラメーターを提供することです。 アプリケーションでは、この省略可能なパラメーターを使用して、データ転送中に状態通知を取得します。 状態通知が必要ない場合は、0 に設定する必要があります。

データ転送の形式は、アイテムのWIA_IPA_FORMATプロパティとWIA_IPA_TYMEDプロパティの値によって決まります。 アプリケーションは、 IWiaPropertyStorage::WriteMultiple メソッドを呼び出してこれらのプロパティを設定します。

IWiaDataTransfer::idtGetBandedData メソッドとは異なり、IWiaDataTransfer::idtGetData は、単一のデータ バンドではなく、WIA デバイスからアプリケーションに完全なファイルを転送します。 pMedium パラメーターは、データ転送に使用されるストレージ・メディアに関する情報を含む STGMEDIUM 構造体へのポインターです。 プログラムは pIWiaDataCallback パラメーターを使用して、このメソッドに IWiaDataCallback インターフェイスへのポインターを渡します。 このメソッドは、定期的にインターフェイス ポインターを使用して BandedDataCallback メソッドを呼び出し、進行中のデータ転送に関する状態情報をアプリケーションに提供します。

PMedium 構造体の lpszFileName メンバーの値として NULL を渡して、WIA が新しいファイルのファイル名と場所を決定できるようにします。 返されると、pMedium 構造体の lpszFileName メンバーには、新しいファイルの場所と名前が含まれます。

このメソッドによって返される値が COM SUCCESS 値であるか、転送がマルチページ ファイル転送であり、返されるエラー コードがWIA_ERROR_PAPER_JAM、WIA_ERROR_PAPER_EMPTY、またはWIA_ERROR_PAPER_PROBLEMである場合、WIA はファイルを削除しません。

要件

   
サポートされている最小のクライアント Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー wia_xp.h (Wia.h を含む)
Library Wiaguid.lib
[DLL] Wiaservc.dll