ホーム › System.UpdateAgent › IUpdateDownloader

IUpdateDownloader

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID68f1c6f9-7ecc-4666-a464-247fe12496c3継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

サーバーから更新プログラムをダウンロードします。

解説(Remarks)

このインターフェースのインスタンスは、UpdateDownloader コクラスを使用して作成できます。オブジェクトの作成には Microsoft.Update.Downloader プログラム識別子を使用します。

メソッド 11

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

vtbl 7 HRESULT get_ClientApplicationID(LPWSTR* retval)

現在のクライアントアプリケーションを取得および設定します。(IUpdateDownloader.get_ClientApplicationID)

retval

LPWSTR*

out

ダウンロードを実行するクライアントアプリケーションの識別子を受け取る文字列ポインタである。

解説(Remarks)

クライアントアプリケーションがこのプロパティを設定していない場合は、値 Unknown を返します。

vtbl 8 HRESULT put_ClientApplicationID(LPWSTR value)

現在のクライアントアプリケーションを取得および設定します。(IUpdateDownloader.put_ClientApplicationID)

value

LPWSTR

ダウンロードを実行するクライアントアプリケーションの識別子を指定する文字列を渡す。

解説(Remarks)

クライアントアプリケーションがこのプロパティを設定していない場合は、値 Unknown を返します。

vtbl 9 HRESULT get_IsForced(VARIANT_BOOL* retval)

Windows Update Agent (WUA) が、既にインストールされている更新プログラム、またはインストールできない更新プログラムのダウンロードを強制するかどうかを示す Boolean 値を取得および設定します。(Get)

retval

VARIANT_BOOL*

out

既にダウンロード済みであっても強制的に再ダウンロードするかどうかを受け取る VARIANT_BOOL へのポインタである。

解説(Remarks)

このインターフェースを実装するオブジェクトがロックダウンされている場合、このメソッドは WU_E_INVALID_OPERATION を返します。

vtbl 10 HRESULT put_IsForced(VARIANT_BOOL value)

Windows Update Agent (WUA) が、既にインストールされている更新プログラム、またはインストールできない更新プログラムのダウンロードを強制するかどうかを示す Boolean 値を取得および設定します。(Put)

value

VARIANT_BOOL

既にダウンロード済みであっても強制的に再ダウンロードするかどうかを指定する VARIANT_BOOL を渡す。

解説(Remarks)

このインターフェースを実装するオブジェクトがロックダウンされている場合、このメソッドは WU_E_INVALID_OPERATION を返します。

vtbl 11 HRESULT get_Priority(DownloadPriority* retval)

ダウンロードの優先度レベルを取得および設定します。(Get)

retval

DownloadPriority*

out

ダウンロードの優先度(DownloadPriority)を受け取るポインタである。

vtbl 12 HRESULT put_Priority(DownloadPriority value)

ダウンロードの優先度レベルを取得および設定します。(Put)

value

DownloadPriority

ダウンロードの優先度(DownloadPriority)を指定する。

vtbl 13 HRESULT get_Updates(IUpdateCollection** retval)

ダウンロード対象として指定された更新プログラムの読み取り専用コレクションを含むインターフェースを取得および設定します。(Get)

retval

IUpdateCollection**

out

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

vtbl 14 HRESULT put_Updates(IUpdateCollection* value)

ダウンロード対象として指定された更新プログラムの読み取り専用コレクションを含むインターフェースを取得および設定します。(Put)

value

IUpdateCollection*

ダウンロード対象の更新プログラムのコレクション(IUpdateCollection)を指定する。

vtbl 15 HRESULT BeginDownload(IUnknown* onProgressChanged, IUnknown* onCompleted, VARIANT state, IDownloadJob** retval)

更新プログラムに関連付けられたコンテンツファイルの非同期ダウンロードを開始します。

onProgressChanged	IUnknown*	in	ダウンロードが完了する前に、ダウンロードの進行状況の変化に応じて定期的に呼び出される IDownloadProgressChangedCallback インターフェースです。
onCompleted	IUnknown*	in	非同期ダウンロード操作が完了したときに呼び出される IDownloadCompletedCallback インターフェース (C++/COM) です。
state	VARIANT	in	IDownloadJob インターフェースの AsyncState プロパティが返す、呼び出し元固有の状態です。呼び出し元はこのパラメーターを使用して、ダウンロードジョブオブジェクトに値を付加できます。これにより、呼び出し元は後からそのダウンロードジョブオブジェクトに関するカスタム情報を取得できます。 Note IDownloadJob インターフェースの AsyncState プロパティは取得できますが、設定はできません。ただし、これは IDownloadJob インターフェースの AsyncState プロパティに既に設定されているオブジェクトの内容を、呼び出し元が変更することを妨げるものではありません。つまり、AsyncState プロパティが数値を含む場合、その数値は変更できません。しかし、AsyncState プロパティが safe array またはオブジェクトを含む場合、その safe array またはオブジェクトの内容は自由に変更できます。この値は、呼び出し元が IUpdateDownloader::EndDownload を呼び出して IDownloadJob を解放したときに解放されます。
retval	IDownloadJob**	out	開始されたダウンロード操作で使用できるプロパティとメソッドを含む IDownloadJob インターフェースです。

戻り値

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

このメソッドは、次のエラーコードを返す場合もあります。

Return code	Description
WU_E_INVALID_OPERATION	コンピューターが更新サイトにアクセスできません。
WU_E_NO_UPDATE	Windows Update Agent (WUA) のコレクションに更新プログラムが含まれていません。
WU_E_NOT_INITIALIZED	Windows Update Agent (WUA) が初期化されていません。

解説(Remarks)

IDownloadProgressChangedCallback インターフェースを実装する代わりに、スクリプトを使用して、オートメーションオブジェクト上に DISPID 0 を持つ任意の識別子のコールバックルーチンを実装することもできます。onProgressChanged パラメーターの型は IUnknown* です。

IDownloadCompletedCallback インターフェースを実装する代わりに、スクリプトを使用して、オートメーションオブジェクト上に DISPID 0 を持つ任意の識別子のコールバックルーチンを実装することもできます。onCompleted パラメーターの型は IUnknown* です。

このインターフェースを実装するオブジェクトがロックダウンされている場合、このメソッドは WU_E_INVALID_OPERATION を返します。

IUpdateDownloader インターフェースの Updates プロパティが設定されていない場合、このメソッドは WU_E_NO_UPDATE を返します。また、Updates プロパティが空のコレクションに設定されている場合も WU_E_NO_UPDATE を返します。

ダウンロードジョブに更新プログラムが含まれていない場合、このメソッドは SUS_E_NOT_INITIALIZED を返します。

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

vtbl 16 HRESULT Download(IDownloadResult** retval)

更新プログラムに関連付けられたコンテンツファイルの同期ダウンロードを開始します。

retval

IDownloadResult**

out

ダウンロードの結果コードを含む IDownloadResult インターフェースです。

戻り値

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

このメソッドは、次のエラーコードを返す場合もあります。

Return code	Description
WU_E_INVALID_OPERATION	コンピューターが更新サイトにアクセスできません。
WU_E_NO_UPDATE	Windows Update Agent (WUA) のコレクションに更新プログラムが含まれていません。
WU_E_NOT_INITIALIZED	Windows Update Agent が初期化されていません。

解説(Remarks)

このインターフェースを実装するオブジェクトがロックダウンされている場合、このメソッドは WU_E_INVALID_OPERATION を返します。

IUpdateDownloader インターフェースの Updates プロパティが設定されていない場合、このメソッドは WU_E_NO_UPDATE を返します。また、Updates プロパティが空のコレクションに設定されている場合も WU_E_NO_UPDATE を返します。

ダウンロードジョブに更新プログラムが含まれていない場合、このメソッドは SUS_E_NOT_INITIALIZED を返します。

vtbl 17 HRESULT EndDownload(IDownloadJob* value, IDownloadResult** retval)

非同期ダウンロードを完了します。

value	IDownloadJob*	in	BeginDownload が返す IDownloadJob インターフェースポインターです。
retval	IDownloadResult**	out	ダウンロードの結果コードを含む IDownloadResult インターフェースです。

戻り値

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

このメソッドは、次のエラーコードを返す場合もあります。

Return code	Description
WU_E_INVALID_OPERATION	コンピューターが更新サイトにアクセスできません。

解説(Remarks)

このインターフェースを実装するオブジェクトがロックダウンされている場合、このメソッドは WU_E_INVALID_OPERATION を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUpdateDownloader "{68F1C6F9-7ECC-4666-A464-247FE12496C3}"
#usecom global IUpdateDownloader IID_IUpdateDownloader "{5BAF654A-5A07-4264-A255-9FF54C7151E7}"
#comfunc global IUpdateDownloader_get_ClientApplicationID  7 var
#comfunc global IUpdateDownloader_put_ClientApplicationID  8 wstr
#comfunc global IUpdateDownloader_get_IsForced             9 var
#comfunc global IUpdateDownloader_put_IsForced             10 int
#comfunc global IUpdateDownloader_get_Priority             11 var
#comfunc global IUpdateDownloader_put_Priority             12 int
#comfunc global IUpdateDownloader_get_Updates              13 sptr
#comfunc global IUpdateDownloader_put_Updates              14 sptr
#comfunc global IUpdateDownloader_BeginDownload            15 sptr,sptr,int,sptr
#comfunc global IUpdateDownloader_Download                 16 sptr
#comfunc global IUpdateDownloader_EndDownload              17 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IUpdateDownloader "{68F1C6F9-7ECC-4666-A464-247FE12496C3}"
#usecom global IUpdateDownloader IID_IUpdateDownloader "{5BAF654A-5A07-4264-A255-9FF54C7151E7}"
#comfunc global IUpdateDownloader_get_ClientApplicationID  7 sptr
#comfunc global IUpdateDownloader_put_ClientApplicationID  8 wstr
#comfunc global IUpdateDownloader_get_IsForced             9 sptr
#comfunc global IUpdateDownloader_put_IsForced             10 int
#comfunc global IUpdateDownloader_get_Priority             11 sptr
#comfunc global IUpdateDownloader_put_Priority             12 int
#comfunc global IUpdateDownloader_get_Updates              13 sptr
#comfunc global IUpdateDownloader_put_Updates              14 sptr
#comfunc global IUpdateDownloader_BeginDownload            15 sptr,sptr,int,sptr
#comfunc global IUpdateDownloader_Download                 16 sptr
#comfunc global IUpdateDownloader_EndDownload              17 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。