ホーム › System.UpdateAgent › IAutomaticUpdates

IAutomaticUpdates

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID673425bf-c082-4c7c-bdfd-569464b8e0ce継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

自動更新の機能を提供します。(IAutomaticUpdates)

解説(Remarks)

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

メソッド 7

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

vtbl 7 HRESULT DetectNow()

自動更新が有効な場合に、自動更新の検出タスクを開始します。更新プログラムが検出された場合、インストールの動作は IAutomaticUpdatesSettings インターフェイスの NotificationLevel プロパティによって決定されます。

戻り値

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

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

戻り値	説明
WU_E_AU_NOSERVICE	自動更新が有効になっていません。
WU_E_AU_PAUSED	自動更新が一時停止されています。
WU_E_LEGACYSERVER	次の条件が満たされる場合、更新プログラムを検索できません: IUpdateSearcher インターフェイスの ServerSelection プロパティが ssManagedServer または ssDefault に設定されている。コンピューター上の管理対象サーバーが Microsoft Software Update Services (SUS) バージョン 1.0 サーバーである。

解説(Remarks)

自動更新が無効、初期化中、初期化解除中、または未構成の場合、このメソッドは WU_E_AU_NOSERVICE を返します。

vtbl 8 HRESULT Pause()

自動更新を一時停止します。

戻り値

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

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

戻り値	説明
E_ACCESSDENIED	このメソッドはリモートコンピューターから呼び出すことはできません。
WU_E_INVALID_OPERATION	コンピューターが更新サイトにアクセスできませんでした。
WU_E_AU_NOSERVICE	自動更新が有効になっていません。
WU_E_AU_PAUSED	自動更新が一時停止されています。
WU_E_LEGACYSERVER	次の条件が満たされる場合、更新プログラムを検索できません: IUpdateSearcher インターフェイスの ServerSelection プロパティが ssManagedServer または ssDefault に設定されている。コンピューター上の管理対象サーバーが Microsoft Software Update Services (SUS) 1.0 サーバーである。

解説(Remarks)

このメソッドには管理者権限が必要です。

自動更新は 8 時間だけ一時停止できます。この制限はバイナリのバージョンによって異なります。呼び出し元は、自動更新を一時停止する必要がなくなったら、Pause を呼び出した後にできるだけ早く Resume メソッドを呼び出す必要があります。

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

自動更新が無効、初期化中、初期化解除中、または未構成の場合、このメソッドは WU_E_AU_NOSERVICE を返します。

vtbl 9 HRESULT Resume()

自動更新が一時停止されている場合に、自動更新を再開します。

戻り値

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

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

戻り値	説明
E_ACCESSDENIED	このメソッドはリモートコンピューターから呼び出すことはできません。
WU_E_INVALID_OPERATION	コンピューターが更新サイトにアクセスできませんでした。
WU_E_AU_NOSERVICE	自動更新が有効になっていません。
WU_E_AU_PAUSED	自動更新が一時停止されています。
WU_E_LEGACYSERVER	次の条件が満たされる場合、更新プログラムを検索できません: IUpdateSearcher インターフェイスの ServerSelection プロパティが ssManagedServer または ssDefault に設定されている。コンピューター上の管理対象サーバーが Microsoft Software Update Services (SUS) 1.0 サーバーである。

解説(Remarks)

このメソッドには管理者権限が必要です。

呼び出し元は、自動更新を一時停止する必要がなくなったら、Pause メソッドを呼び出した後にできるだけ早く Resume を呼び出す必要があります。

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

自動更新が無効、初期化中、初期化解除中、または未構成の場合、このメソッドは WU_E_AU_NOSERVICE を返します。

vtbl 10 HRESULT ShowSettingsDialog()

自動更新の設定を含むダイアログボックスを表示します。

戻り値

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

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

戻り値	説明
E_ACCESSDENIED	このメソッドはリモートコンピューターから呼び出すことはできません。
WU_E_AU_NOSERVICE	自動更新が有効になっていません。
WU_E_AU_PAUSED	自動更新が一時停止されています。
WU_E_LEGACYSERVER	次の条件が満たされる場合、更新プログラムを検索できません: IUpdateSearcher インターフェイスの ServerSelection プロパティが ssManagedServer または ssDefault に設定されている。コンピューター上の管理対象サーバーが Microsoft Software Update Services (SUS) 1.0 サーバーである。

解説(Remarks)

呼び出し元のユーザーがログオンしていない場合、またはデスクトップを持たない場合、ShowSettingsDialog の呼び出しは失敗します。呼び出し元は、Settings プロパティを使用して、プログラムから自動更新の設定を変更することもできます。

呼び出し元のセキュリティ権限が不足している場合、またはグループポリシー設定を使用するドメイン管理者によって設定が強制されている場合、ダイアログボックス内の設定は読み取り専用になります。

自動更新が無効、初期化中、初期化解除中、または未構成の場合、このメソッドは WU_E_AU_NOSERVICE を返します。

vtbl 11 HRESULT get_Settings(IAutomaticUpdatesSettings** retval)

自動更新の構成設定を取得します。

retval

IAutomaticUpdatesSettings**

out

自動更新の設定を表す IAutomaticUpdatesSettings インターフェイスを受け取るポインタへのポインタである。

解説(Remarks)

返されるインターフェイスは、現在の設定の変更および読み取りに使用できます。

vtbl 12 HRESULT get_ServiceEnabled(VARIANT_BOOL* retval)

自動更新が必要とするすべてのコンポーネントが利用可能かどうかを示すブール値を取得します。

retval

VARIANT_BOOL*

out

自動更新サービスが有効かどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。

vtbl 13 HRESULT EnableService()

自動更新が必要とするすべてのコンポーネントを有効にします。

戻り値

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

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

戻り値	説明
E_ACCESSDENIED	このメソッドはリモートコンピューターから呼び出すことはできません。
WU_E_AU_NOSERVICE	自動更新が有効になっていません。
WU_E_AU_PAUSED	自動更新が一時停止されています。
WU_E_LEGACYSERVER	次の条件が満たされる場合、更新プログラムを検索できません: IUpdateSearcher インターフェイスの ServerSelection プロパティが ssManagedServer または ssDefault に設定されている。コンピューター上の管理対象サーバーが Microsoft Software Update Services (SUS) 1.0 サーバーである。

解説(Remarks)

このメソッドには管理者権限が必要です。

自動更新が無効、初期化中、初期化解除中、または未構成の場合、このメソッドは WU_E_AU_NOSERVICE を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAutomaticUpdates "{673425BF-C082-4C7C-BDFD-569464B8E0CE}"
#usecom global IAutomaticUpdates IID_IAutomaticUpdates "{BFE18E9C-6D87-4450-B37C-E02F0B373803}"
#comfunc global IAutomaticUpdates_DetectNow           7
#comfunc global IAutomaticUpdates_Pause               8
#comfunc global IAutomaticUpdates_Resume              9
#comfunc global IAutomaticUpdates_ShowSettingsDialog  10
#comfunc global IAutomaticUpdates_get_Settings        11 sptr
#comfunc global IAutomaticUpdates_get_ServiceEnabled  12 var
#comfunc global IAutomaticUpdates_EnableService       13
; ※数字は 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_IAutomaticUpdates "{673425BF-C082-4C7C-BDFD-569464B8E0CE}"
#usecom global IAutomaticUpdates IID_IAutomaticUpdates "{BFE18E9C-6D87-4450-B37C-E02F0B373803}"
#comfunc global IAutomaticUpdates_DetectNow           7
#comfunc global IAutomaticUpdates_Pause               8
#comfunc global IAutomaticUpdates_Resume              9
#comfunc global IAutomaticUpdates_ShowSettingsDialog  10
#comfunc global IAutomaticUpdates_get_Settings        11 sptr
#comfunc global IAutomaticUpdates_get_ServiceEnabled  12 sptr
#comfunc global IAutomaticUpdates_EnableService       13
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。