ホーム › System.UpdateAgent › IDownloadJob

IDownloadJob

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IIDc574de85-7358-43f6-aae8-8697e62d8ba7継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ダウンロード操作で使用できるプロパティとメソッドを格納します。

メソッド 6

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_AsyncState(VARIANT* retval)

IUpdateDownloader.BeginDownload メソッドに渡される、呼び出し元固有の状態オブジェクトを取得します。

retval

VARIANT*

out

非同期ダウンロードの開始時に渡された呼び出し元定義の状態オブジェクトを受け取る VARIANT へのポインタである。

解説(Remarks)

この状態オブジェクトは、呼び出し元が特定のダウンロードを識別するために使用できます。または、呼び出し元から IDownloadProgressChangedCallback インターフェースまたは IDownloadCompletedCallback インターフェースの実装へ情報を渡すために使用することもできます。

vtbl 8 HRESULT get_IsCompleted(VARIANT_BOOL* retval)

IUpdateDownloader.BeginDownload の呼び出しが完全に処理されたかどうかを示す設定を取得します。

retval

VARIANT_BOOL*

out

非同期ダウンロードジョブが完了したかどうかを受け取る VARIANT_BOOL へのポインタである。

vtbl 9 HRESULT get_Updates(IUpdateCollection** retval)

ダウンロードで指定された更新プログラムの読み取り専用コレクションを格納するインターフェースを取得します。

retval

IUpdateCollection**

out

このダウンロードジョブの対象となる更新プログラムのコレクション(IUpdateCollection)を受け取るポインタである。

vtbl 10 HRESULT CleanUp()

非同期操作の完了を待機し、すべてのコールバックを解放します。

戻り値

成功した場合は S_OK を返します。それ以外の場合は、COM または Windows のエラーコードを返します。

解説(Remarks)

アプリで非同期の WUA API を使用する場合は、タイムアウト機構の実装が必要になることがあります。非同期の WUA 操作を実行する方法の詳細については、Guidelines for Asynchronous WUA Operations を参照してください。

vtbl 11 HRESULT GetProgress(IDownloadProgress** retval)

ダウンロードの現在の進行状況を表す IDownloadProgress インターフェースを返します。

retval

IDownloadProgress**

out

ダウンロードの現在の進行状況を表す IDownloadProgress インターフェース。

戻り値

成功した場合は S_OK を返します。それ以外の場合は、COM または Windows のエラーコードを返します。

解説(Remarks)

ダウンロードの進行状況を追跡するには、GetProgress を繰り返し呼び出す必要があります。これは、
IDownloadProgress インターフェースがダウンロード中に自動的には更新されないためです。

vtbl 12 HRESULT RequestAbort()

非同期ダウンロードを終了するよう要求します。

戻り値

成功した場合は S_OK を返します。それ以外の場合は、COM または Windows のエラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDownloadJob "{C574DE85-7358-43F6-AAE8-8697E62D8BA7}"
#usecom global IDownloadJob IID_IDownloadJob "{}"
#comfunc global IDownloadJob_get_AsyncState   7 var
#comfunc global IDownloadJob_get_IsCompleted  8 var
#comfunc global IDownloadJob_get_Updates      9 sptr
#comfunc global IDownloadJob_CleanUp          10
#comfunc global IDownloadJob_GetProgress      11 sptr
#comfunc global IDownloadJob_RequestAbort     12
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IDownloadJob "{C574DE85-7358-43F6-AAE8-8697E62D8BA7}"
#usecom global IDownloadJob IID_IDownloadJob "{}"
#comfunc global IDownloadJob_get_AsyncState   7 sptr
#comfunc global IDownloadJob_get_IsCompleted  8 sptr
#comfunc global IDownloadJob_get_Updates      9 sptr
#comfunc global IDownloadJob_CleanUp          10
#comfunc global IDownloadJob_GetProgress      11 sptr
#comfunc global IDownloadJob_RequestAbort     12
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。