ホーム › System.UpdateAgent › IUpdateInstaller

IUpdateInstaller

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID7b929c68-ccdc-4226-96b1-8724600b54c2継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

コンピューターに対して更新プログラムのインストールまたはアンインストールを行います。

解説(Remarks)

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

メソッド 21

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

vtbl 7 HRESULT get_ClientApplicationID(LPWSTR* retval)

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

retval

LPWSTR*

out

現在設定されているクライアントアプリケーション識別子を受け取る文字列ポインタである。呼び出し元がイベントログ等で使用する。

解説(Remarks)

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

vtbl 8 HRESULT put_ClientApplicationID(LPWSTR value)

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

value

LPWSTR

更新の操作を識別するために設定するクライアントアプリケーション識別子の文字列を指定する。

解説(Remarks)

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

vtbl 9 HRESULT get_IsForced(VARIANT_BOOL* retval)

更新プログラムを強制的にインストールまたはアンインストールするかどうかを示す Boolean 値を取得または設定します。(Get)

retval

VARIANT_BOOL*

out

インストールが強制モードで実行されるかどうかを受け取る VARIANT_BOOL へのポインタである。

解説(Remarks)

強制インストールとは、メタデータが更新プログラムは既にインストール済みであることを示している場合でも、その更新プログラムをインストールするインストールです。強制アンインストールとは、メタデータが更新プログラムはインストールされていないことを示している場合でも、その更新プログラムを削除するアンインストールです。

IsForced を使用してインストールを強制する前に、更新プログラムがインストール済みで利用可能かどうかを確認してください。更新プログラムがインストールされていない場合、強制インストールは失敗します。たとえば、更新プログラムがダウンロードされた後、有効期限を過ぎて対応するファイルがキャッシュから削除されることがあります。この場合、ファイルがインストールされていないと、その更新プログラムの強制インストールは失敗します。

vtbl 10 HRESULT put_IsForced(VARIANT_BOOL value)

更新プログラムを強制的にインストールまたはアンインストールするかどうかを示す Boolean 値を取得または設定します。(Put)

value

VARIANT_BOOL

更新が既にインストール済みであっても強制的に再インストールするかどうかを指定する VARIANT_BOOL である。

解説(Remarks)

vtbl 11 HRESULT get_ParentHwnd(HWND* retval)

ダイアログボックスを格納できる親ウィンドウのハンドルを取得および設定します。(Get)

retval

HWND*

out

ダイアログ等の親として使用されるウィンドウハンドルを受け取る HWND へのポインタである。

解説(Remarks)

このプロパティは、コンピューター上のユーザーのみが変更できます。このプロパティは IDispatch インターフェイスを使用してアクセスすることはできません。

vtbl 12 HRESULT put_ParentHwnd(HWND value)

ダイアログボックスを格納できる親ウィンドウのハンドルを取得および設定します。(Put)

value

HWND

インストール時に表示される UI の親となるウィンドウハンドルを指定する。

解説(Remarks)

vtbl 13 HRESULT put_ParentWindow(IUnknown* value)

ダイアログボックスを格納できる親ウィンドウを表すインターフェイスを取得および設定します。(Put)

value

IUnknown*

親ウィンドウを表す IUnknown インターフェイスへのポインタを指定する。NULL を指定すると親ウィンドウを設定しない。

解説(Remarks)

このプロパティは、コンピューター上のユーザーのみが変更できます。このプロパティは IDispatch インターフェイスを使用してアクセスできます。

vtbl 14 HRESULT get_ParentWindow(IUnknown** retval)

ダイアログボックスを格納できる親ウィンドウを表すインターフェイスを取得および設定します。(Get)

retval

IUnknown**

out

設定されている親ウィンドウの IUnknown インターフェイスを受け取るポインタである。

解説(Remarks)

このプロパティは、コンピューター上のユーザーのみが変更できます。このプロパティは IDispatch インターフェイスを使用してアクセスできます。

vtbl 15 HRESULT get_Updates(IUpdateCollection** retval)

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

retval

IUpdateCollection**

out

インストールまたはアンインストール対象として設定された更新のコレクションを受け取る IUpdateCollection へのポインタである。

vtbl 16 HRESULT put_Updates(IUpdateCollection* value)

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

value

IUpdateCollection*

インストールまたはアンインストール対象とする更新のコレクションを指定する IUpdateCollection へのポインタである。

vtbl 17 HRESULT BeginInstall(IUnknown* onProgressChanged, IUnknown* onCompleted, VARIANT state, IInstallationJob** retval)

更新プログラムの非同期インストールを開始します。

onProgressChanged	IUnknown*	in	インストールが完了する前に、インストールの進行状況の変化に応じて定期的に呼び出される IInstallationProgressChangedCallback インターフェイスです。
onCompleted	IUnknown*	in	インストール操作が完了したときに呼び出される IInstallationCompletedCallback インターフェイスです。
state	VARIANT	in	IInstallationJob インターフェイスの AsyncState プロパティが返す、呼び出し元固有の状態です。
retval	IInstallationJob**	out	開始された非同期インストール操作で利用できるプロパティおよびメソッドを含む IInstallationJob インターフェイスです。

戻り値

このメソッドは、次の HRESULT 値、およびその他の COM または Windows のエラーコードを返します。

リターンコード	説明
S_OK	更新プログラムの非同期インストールが正常に開始されました。
WU_E_INSTALL_NOT_ALLOWED	インストーラーが更新プログラムをインストールまたは削除している間は、このメソッドを呼び出すことはできません。このメソッドは、IUpdateInstaller インターフェイスの IsBusy プロパティが VARIANT_FALSE を返す場合にのみ呼び出してください。
WU_E_NO_UPDATE	Windows Update Agent (WUA) のコレクションに更新プログラムがありません。

解説(Remarks)

スクリプト言語からこのメソッドを呼び出す場合は、onProgressChanged パラメーターに、コールバックルーチンを実装し、ディスパッチ識別子 (DISPID) が 0 の Automation オブジェクトの識別子を設定します。onCompleted パラメーターについても同様に設定します。

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

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

vtbl 18 HRESULT BeginUninstall(IUnknown* onProgressChanged, IUnknown* onCompleted, VARIANT state, IInstallationJob** retval)

更新プログラムの非同期アンインストールを開始します。

onProgressChanged	IUnknown*	in	アンインストールが完了する前に、アンインストールの進行状況の変化に応じて定期的に呼び出される IInstallationProgressChangedCallback インターフェイスです。
onCompleted	IUnknown*	in	インストール操作が完了したときに呼び出される IInstallationCompletedCallback インターフェイスです。
state	VARIANT	in	IInstallationJob インターフェイスの AsyncState プロパティが返す、呼び出し元固有の状態です。
retval	IInstallationJob**	out	開始された非同期アンインストール操作で利用できるプロパティおよびメソッドを含む IInstallationJob インターフェイスです。

戻り値

このメソッドは、次の HRESULT 値、およびその他の COM または Windows のエラーコードを返します。

リターンコード	説明
S_OK	更新プログラムの非同期削除が正常に開始されました。
WU_E_INSTALL_NOT_ALLOWED	インストーラーが更新プログラムをインストールまたは削除している間は、このメソッドを呼び出さないでください。このメソッドは、IUpdateInstaller インターフェイスの IsBusy プロパティが VARIANT_FALSE を返す場合にのみ呼び出してください。
WU_E_NO_UPDATE	Windows Update Agent (WUA) のコレクションに更新プログラムがありません。

解説(Remarks)

vtbl 19 HRESULT EndInstall(IInstallationJob* value, IInstallationResult** retval)

更新プログラムの非同期インストールを完了します。

value	IInstallationJob*	in	BeginInstall メソッドが返す IInstallationJob インターフェイスです。
retval	IInstallationResult**	out	インストール操作の全体的な結果を表す IInstallationResult インターフェイスです。

戻り値

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

解説(Remarks)

vtbl 20 HRESULT EndUninstall(IInstallationJob* value, IInstallationResult** retval)

更新プログラムの非同期アンインストールを完了します。

value	IInstallationJob*	in	BeginUninstall メソッドが返す IInstallationJob インターフェイスです。
retval	IInstallationResult**	out	アンインストール操作の全体的な結果を表す IInstallationResult インターフェイスです。

戻り値

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

解説(Remarks)

vtbl 21 HRESULT Install(IInstallationResult** retval)

更新プログラムの同期インストールを開始します。

retval

IInstallationResult**

out

要求で指定された各更新プログラムに対するインストール操作の結果を表す IInstallationResult インターフェイスです。

戻り値

このメソッドは、次の HRESULT 値、およびその他の COM または Windows のエラーコードを返します。

リターンコード	説明
S_OK	更新プログラムが正常にインストールされました。
WU_E_INSTALL_NOT_ALLOWED	インストーラーが更新プログラムをインストールまたは削除している間は、このメソッドを呼び出さないでください。このメソッドは、IUpdateInstaller インターフェイスの IsBusy プロパティが VARIANT_FALSE を返す場合にのみ呼び出してください。
WU_E_NO_UPDATE	コレクションに更新プログラムがありません。

解説(Remarks)

vtbl 22 HRESULT RunWizard(LPWSTR dialogTitle, IInstallationResult** retval)

ローカルユーザーが更新プログラムをインストールする手順を案内するウィザードを開始します。

dialogTitle

LPWSTR

ウィザードのタイトルバーに表示される、省略可能な文字列値です。

空の文字列値を指定した場合は、次のテキストが表示されます: Download and Install Updates。

retval

IInstallationResult**

out

要求で指定された各更新プログラムに対するインストール操作の結果を表す IInstallationResult インターフェイスです。

戻り値

このメソッドは、次の HRESULT 値、およびその他の COM または Windows のエラーコードを返します。

リターンコード	説明
WU_E_NO_UPDATE	コレクションに更新プログラムがありません。

解説(Remarks)

vtbl 23 HRESULT get_IsBusy(VARIANT_BOOL* retval)

特定の時点でコンピューター上でインストールまたはアンインストールが進行中かどうかを示す Boolean 値を取得します。

retval

VARIANT_BOOL*

out

インストーラーが現在インストールまたはアンインストールを実行中かどうかを受け取る VARIANT_BOOL へのポインタである。

解説(Remarks)

新しいインストールまたはアンインストールは、他のインストールまたはアンインストールが進行中でない場合にのみ処理されます。インストールまたはアンインストールが進行中の間は、新しいインストールまたはアンインストールは WU_E_OPERATIONINPROGRESS エラーによって直ちに失敗します。IsBusy プロパティは、呼び出し元が新しいインストールまたはアンインストールを開始できることを保証するものではありません。IsBusy プロパティ、または直近のインストールもしくはアンインストールの失敗によって、別のインストールまたはアンインストールが既に進行中であることが示された場合は、呼び出し元は後でインストールまたはアンインストールを試行してください。

vtbl 24 HRESULT Uninstall(IInstallationResult** retval)

更新プログラムの同期アンインストールを開始します。

retval

IInstallationResult**

out

要求で指定された各更新プログラムに対するアンインストール操作の結果を表す IInstallationResult インターフェイスです。

戻り値

このメソッドは、次の HRESULT 値、およびその他の COM または Windows のエラーコードを返します。

リターンコード	説明
S_OK	更新プログラムが正常にアンインストールされました。
WU_E_INSTALL_NOT_ALLOWED	インストーラーが更新プログラムをインストールまたは削除している間は、このメソッドを呼び出さないでください。このメソッドは、IUpdateInstaller インターフェイスの IsBusy プロパティが VARIANT_FALSE を返す場合にのみ呼び出してください。
WU_E_NO_UPDATE	コレクションに更新プログラムがありません。

解説(Remarks)

vtbl 25 HRESULT get_AllowSourcePrompts(VARIANT_BOOL* retval)

更新プログラムのインストール時にソースプロンプトをユーザーに表示するかどうかを示す Boolean 値を取得および設定します。(Get)

retval

VARIANT_BOOL*

out

ソースメディアの要求プロンプトを許可するかどうかを受け取る VARIANT_BOOL へのポインタである。

vtbl 26 HRESULT put_AllowSourcePrompts(VARIANT_BOOL value)

更新プログラムのインストール時にソースプロンプトをユーザーに表示するかどうかを示す Boolean 値を取得および設定します。(Put)

value

VARIANT_BOOL

インストール中にソースメディアの要求プロンプトを許可するかどうかを指定する VARIANT_BOOL である。

vtbl 27 HRESULT get_RebootRequiredBeforeInstallation(VARIANT_BOOL* retval)

更新プログラムをインストールまたはアンインストールする前にシステムの再起動が必要かどうかを示す Boolean 値を取得します。

retval

VARIANT_BOOL*

out

インストール前に再起動が必要かどうかを受け取る VARIANT_BOOL へのポインタである。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUpdateInstaller "{7B929C68-CCDC-4226-96B1-8724600B54C2}"
#usecom global IUpdateInstaller IID_IUpdateInstaller "{D2E0FE7F-D23E-48E1-93C0-6FA8CC346474}"
#comfunc global IUpdateInstaller_get_ClientApplicationID               7 var
#comfunc global IUpdateInstaller_put_ClientApplicationID               8 wstr
#comfunc global IUpdateInstaller_get_IsForced                          9 var
#comfunc global IUpdateInstaller_put_IsForced                          10 int
#comfunc global IUpdateInstaller_get_ParentHwnd                        11 sptr
#comfunc global IUpdateInstaller_put_ParentHwnd                        12 sptr
#comfunc global IUpdateInstaller_put_ParentWindow                      13 sptr
#comfunc global IUpdateInstaller_get_ParentWindow                      14 sptr
#comfunc global IUpdateInstaller_get_Updates                           15 sptr
#comfunc global IUpdateInstaller_put_Updates                           16 sptr
#comfunc global IUpdateInstaller_BeginInstall                          17 sptr,sptr,int,sptr
#comfunc global IUpdateInstaller_BeginUninstall                        18 sptr,sptr,int,sptr
#comfunc global IUpdateInstaller_EndInstall                            19 sptr,sptr
#comfunc global IUpdateInstaller_EndUninstall                          20 sptr,sptr
#comfunc global IUpdateInstaller_Install                               21 sptr
#comfunc global IUpdateInstaller_RunWizard                             22 wstr,sptr
#comfunc global IUpdateInstaller_get_IsBusy                            23 var
#comfunc global IUpdateInstaller_Uninstall                             24 sptr
#comfunc global IUpdateInstaller_get_AllowSourcePrompts                25 var
#comfunc global IUpdateInstaller_put_AllowSourcePrompts                26 int
#comfunc global IUpdateInstaller_get_RebootRequiredBeforeInstallation  27 var
; ※数字は 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_IUpdateInstaller "{7B929C68-CCDC-4226-96B1-8724600B54C2}"
#usecom global IUpdateInstaller IID_IUpdateInstaller "{D2E0FE7F-D23E-48E1-93C0-6FA8CC346474}"
#comfunc global IUpdateInstaller_get_ClientApplicationID               7 sptr
#comfunc global IUpdateInstaller_put_ClientApplicationID               8 wstr
#comfunc global IUpdateInstaller_get_IsForced                          9 sptr
#comfunc global IUpdateInstaller_put_IsForced                          10 int
#comfunc global IUpdateInstaller_get_ParentHwnd                        11 sptr
#comfunc global IUpdateInstaller_put_ParentHwnd                        12 sptr
#comfunc global IUpdateInstaller_put_ParentWindow                      13 sptr
#comfunc global IUpdateInstaller_get_ParentWindow                      14 sptr
#comfunc global IUpdateInstaller_get_Updates                           15 sptr
#comfunc global IUpdateInstaller_put_Updates                           16 sptr
#comfunc global IUpdateInstaller_BeginInstall                          17 sptr,sptr,int,sptr
#comfunc global IUpdateInstaller_BeginUninstall                        18 sptr,sptr,int,sptr
#comfunc global IUpdateInstaller_EndInstall                            19 sptr,sptr
#comfunc global IUpdateInstaller_EndUninstall                          20 sptr,sptr
#comfunc global IUpdateInstaller_Install                               21 sptr
#comfunc global IUpdateInstaller_RunWizard                             22 wstr,sptr
#comfunc global IUpdateInstaller_get_IsBusy                            23 sptr
#comfunc global IUpdateInstaller_Uninstall                             24 sptr
#comfunc global IUpdateInstaller_get_AllowSourcePrompts                25 sptr
#comfunc global IUpdateInstaller_put_AllowSourcePrompts                26 int
#comfunc global IUpdateInstaller_get_RebootRequiredBeforeInstallation  27 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 不要)。