ホーム › System.UpdateAgent › ISearchJob
ISearchJob
COMIDispatch (デュアル)✅ IDispatch を実装(デュアルインターフェース)。HSP では
comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
検索操作で使用できるプロパティとメソッドを含みます。
メソッド 4
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
IUpdateSearch.BeginSearch メソッドに渡される、呼び出し元固有の状態オブジェクトを取得します。
| retval | VARIANT* | out | 非同期検索の開始時に渡された呼び出し元定義の状態オブジェクトを受け取る VARIANT へのポインタである。 |
vtbl 8 HRESULT get_IsCompleted(VARIANT_BOOL* retval)
IUpdateSearch.BeginSearch メソッドの呼び出しが完全に処理されたかどうかを示す Boolean 値を取得します。
| retval | VARIANT_BOOL* | out | 非同期検索ジョブが完了したかどうかを受け取る VARIANT_BOOL へのポインタである。 |
vtbl 9 HRESULT CleanUp()
非同期操作の完了を待ってから、すべてのコールバックを解放します。
戻り値
成功した場合は S_OK を返します。それ以外の場合は、COM または Windows のエラーコードを返します。
解説(Remarks)
アプリで非同期の WUA API を使用する場合は、タイムアウト機構の実装が必要になることがあります。非同期の WUA 操作を実行する方法について詳しくは、Guidelines for Asynchronous WUA Operations を参照してください。
vtbl 10 HRESULT RequestAbort()
非同期検索のキャンセルを要求します。
戻り値
成功した場合は S_OK を返します。それ以外の場合は、COM または Windows のエラーコードを返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_ISearchJob "{7366EA16-7A1A-4EA2-B042-973D3E9CD99B}" #usecom global ISearchJob IID_ISearchJob "{}" #comfunc global ISearchJob_get_AsyncState 7 var #comfunc global ISearchJob_get_IsCompleted 8 var #comfunc global ISearchJob_CleanUp 9 #comfunc global ISearchJob_RequestAbort 10 ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ISearchJob "{7366EA16-7A1A-4EA2-B042-973D3E9CD99B}" #usecom global ISearchJob IID_ISearchJob "{}" #comfunc global ISearchJob_get_AsyncState 7 sptr #comfunc global ISearchJob_get_IsCompleted 8 sptr #comfunc global ISearchJob_CleanUp 9 #comfunc global ISearchJob_RequestAbort 10 ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。