Win32 API 日本語リファレンス
ホーム › System.UpdateAgent › IDownloadProgress

IDownloadProgress

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDd31a5bac-f719-4178-9dbb-5e2cb47fd18a継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

非同期ダウンロード操作の進行状況を表します。

メソッド 9

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

vtbl 7 HRESULT get_CurrentUpdateBytesDownloaded(DECIMAL* retval)

ダウンロード中の更新プログラムのコンテンツファイルについて、既に転送されたデータ量をバイト単位で示す文字列を取得します。

retvalDECIMAL*out現在ダウンロード中の更新プログラムについて、これまでにダウンロードしたバイト数を受け取る DECIMAL へのポインタである。
vtbl 8 HRESULT get_CurrentUpdateBytesToDownload(DECIMAL* retval)

ダウンロード中の更新プログラムのコンテンツファイルについて、転送されるべきデータ量の見積もりをバイト単位で示す文字列を取得します。

retvalDECIMAL*out現在ダウンロード中の更新プログラムについて、ダウンロードすべき合計バイト数を受け取る DECIMAL へのポインタである。
vtbl 9 HRESULT get_CurrentUpdateIndex(INT* retval)

複数の更新プログラムが選択されている場合に、現在ダウンロード中の更新プログラムを示す 0 から始まるインデックス値を取得します。

retvalINT*out現在ダウンロード中の更新プログラムの 0 から始まるインデックスを受け取る INT へのポインタである。
vtbl 10 HRESULT get_PercentComplete(INT* retval)

すべての更新プログラムのうちダウンロードが完了した割合の見積もりを取得します。

retvalINT*outダウンロード操作全体の進捗率(0〜100)を受け取る INT へのポインタである。
vtbl 11 HRESULT get_TotalBytesDownloaded(DECIMAL* retval)

これまでにダウンロードされたデータの総量をバイト単位で示す文字列を取得します。

retvalDECIMAL*outダウンロード操作全体でこれまでにダウンロードした合計バイト数を受け取る DECIMAL へのポインタである。
vtbl 12 HRESULT get_TotalBytesToDownload(DECIMAL* retval)

ダウンロードされるデータ総量の見積もりをバイト単位で表す文字列を取得します。

retvalDECIMAL*outダウンロード操作全体でダウンロードすべき合計バイト数を受け取る DECIMAL へのポインタである。
vtbl 13 HRESULT GetUpdateResult(INT updateIndex, IUpdateDownloadResult** retval)

指定した更新プログラムのダウンロード結果を返します。

updateIndexINTin更新プログラムを示す 0 から始まるインデックス値です。
retvalIUpdateDownloadResult**out指定した更新プログラムに関する情報を含む IUpdateDownloadResult インターフェイスです。

戻り値

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

vtbl 14 HRESULT get_CurrentUpdateDownloadPhase(DownloadPhase* retval)

現在進行中のダウンロードのフェーズを示す DownloadPhase 列挙値を取得します。

retvalDownloadPhase*out現在ダウンロード中の更新プログラムのダウンロード フェーズ(DownloadPhase)を受け取るポインタである。
vtbl 15 HRESULT get_CurrentUpdatePercentComplete(INT* retval)

現在の更新プログラムのうちダウンロードが完了した割合の見積もりを取得します。

retvalINT*out現在ダウンロード中の更新プログラムの進捗率(0〜100)を受け取る INT へのポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDownloadProgress "{D31A5BAC-F719-4178-9DBB-5E2CB47FD18A}"
#usecom global IDownloadProgress IID_IDownloadProgress "{}"
#comfunc global IDownloadProgress_get_CurrentUpdateBytesDownloaded  7 var
#comfunc global IDownloadProgress_get_CurrentUpdateBytesToDownload  8 var
#comfunc global IDownloadProgress_get_CurrentUpdateIndex            9 var
#comfunc global IDownloadProgress_get_PercentComplete               10 var
#comfunc global IDownloadProgress_get_TotalBytesDownloaded          11 var
#comfunc global IDownloadProgress_get_TotalBytesToDownload          12 var
#comfunc global IDownloadProgress_GetUpdateResult                   13 int,sptr
#comfunc global IDownloadProgress_get_CurrentUpdateDownloadPhase    14 var
#comfunc global IDownloadProgress_get_CurrentUpdatePercentComplete  15 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。