ホーム › System.WindowsSync › IAsynchronousDataRetriever

IAsynchronousDataRetriever

COM

📘 Microsoft Learn (日本語) · English

IID9fc7e470-61ea-4a88-9be4-df56a27cfef2継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

宛先プロバイダーがソースプロバイダーからアイテムデータを非同期に取得するための仕組みを表します。

メソッド 4

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetIdParameters(ID_PARAMETERS* pIdParameters)

プロバイダーの ID フォーマットスキーマを取得します。(IAsynchronousDataRetriever.GetIdParameters)

pIdParameters

ID_PARAMETERS*

inout

プロバイダーの ID フォーマットスキーマを返します。

戻り値

返される可能性のあるコードには、次の表に示す値が含まれます (ただしこれらに限定されません)。

戻り値	説明
S_OK	メソッドが成功しました。
プロバイダーが定義するエラーコード。

vtbl 4 HRESULT RegisterCallback(IDataRetrieverCallback* pDataRetrieverCallback)

非同期メソッドの処理が完了したときに IAsynchronousDataRetriever オブジェクトから呼び出されるコールバックインターフェースを登録します。

pDataRetrieverCallback

IDataRetrieverCallback*

登録するコールバックインターフェース。

戻り値

返される可能性のあるコードには、次の表に示す値が含まれます (ただしこれらに限定されません)。

戻り値	説明
S_OK	メソッドが成功しました。
プロバイダーが定義するエラーコード。

vtbl 5 HRESULT RevokeCallback(IDataRetrieverCallback* pDataRetrieverCallback)

IAsynchronousDataRetriever オブジェクトが、指定されたコールバックインターフェースをこれ以上使用してはならず、そのインターフェースへの参照をすべて解放する必要があることを示します。

pDataRetrieverCallback

IDataRetrieverCallback*

解放するコールバックインターフェース。

戻り値

返される可能性のあるコードには、次の表に示す値が含まれます (ただしこれらに限定されません)。

戻り値	説明
S_OK	メソッドが成功しました。
プロバイダーが定義するエラーコード。

vtbl 6 HRESULT LoadChangeData(ILoadChangeContext* pLoadChangeContext)

変更に対応するアイテムデータを取得します。(IAsynchronousDataRetriever.LoadChangeData)

pLoadChangeContext

ILoadChangeContext*

データを取得する対象の変更を記述するメタデータ。

戻り値

返される可能性のあるコードには、次の表に示す値が含まれます (ただしこれらに限定されません)。

戻り値	説明
S_OK	メソッドが成功しました。
プロバイダーが定義するエラーコード。	「解説」を参照してください。

解説(Remarks)

LoadChangeData が呼び出されたとき、プロバイダーは次のいずれかの動作を行う必要があります。

メソッドから成功コードを返し、その後 IDataRetrieverCallback::LoadChangeDataComplete を呼び出して、非同期処理が正常に完了したことを報告します。
メソッドから成功コードを返し、その後 IDataRetrieverCallback::LoadChangeDataError を呼び出して、非同期処理中にエラーが発生したことを報告します。
メソッドからエラーコードを返します。この場合、IDataRetrieverCallback のメソッドを呼び出してはなりません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IAsynchronousDataRetriever "{9FC7E470-61EA-4A88-9BE4-DF56A27CFEF2}"
#usecom global IAsynchronousDataRetriever IID_IAsynchronousDataRetriever "{}"
#comfunc global IAsynchronousDataRetriever_GetIdParameters   3 var
#comfunc global IAsynchronousDataRetriever_RegisterCallback  4 sptr
#comfunc global IAsynchronousDataRetriever_RevokeCallback    5 sptr
#comfunc global IAsynchronousDataRetriever_LoadChangeData    6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IAsynchronousDataRetriever "{9FC7E470-61EA-4A88-9BE4-DF56A27CFEF2}"
#usecom global IAsynchronousDataRetriever IID_IAsynchronousDataRetriever "{}"
#comfunc global IAsynchronousDataRetriever_GetIdParameters   3 sptr
#comfunc global IAsynchronousDataRetriever_RegisterCallback  4 sptr
#comfunc global IAsynchronousDataRetriever_RevokeCallback    5 sptr
#comfunc global IAsynchronousDataRetriever_LoadChangeData    6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。