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

IUpdate

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

公式ドキュメント

更新プログラムで利用できるプロパティとメソッドを保持します。(IUpdate)

解説(Remarks)

BundledUpdates プロパティが IUpdateCollection を保持している場合、更新プログラムの一部のプロパティやメソッドは、バンドルされた更新プログラムでのみ利用できることがあります。たとえば DownloadContents や CopyFromCache がこれに該当します。

メソッド 45

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

vtbl 7 HRESULT get_Title(LPWSTR* retval)

更新プログラムのローカライズされたタイトルを取得します。

retvalLPWSTR*out更新のタイトルを受け取る文字列ポインタへのポインタである。

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

vtbl 8 HRESULT get_AutoSelectOnWebSites(VARIANT_BOOL* retval)

更新プログラムが Windows Update によって自動的に選択されるようフラグが設定されているかどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*outWeb サイト上で自動的に選択される更新かどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 9 HRESULT get_BundledUpdates(IUpdateCollection** retval)

更新プログラムにバンドルされた更新プログラムの順序付きリストに関する情報を保持するインターフェイスを取得します。

retvalIUpdateCollection**outこの更新にバンドルされている更新のコレクションを表す IUpdateCollection インターフェイスを受け取るポインタへのポインタである。
vtbl 10 HRESULT get_CanRequireSource(VARIANT_BOOL* retval)

更新プログラムのインストールまたはアンインストールにソースメディアが必要かどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*outインストール時にソースメディアを必要とする可能性があるかどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 11 HRESULT get_Categories(ICategoryCollection** retval)

更新プログラムが属するカテゴリのコレクションを保持するインターフェイスを取得します。

retvalICategoryCollection**out更新が属するカテゴリのコレクションを表す ICategoryCollection インターフェイスを受け取るポインタへのポインタである。

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

IUpdate の Categories プロパティと IUpdateHistoryEntry2 の Categories プロパティが存在するため、ICategory インターフェイスのローカライズされたプロパティで使用される情報は、ICategory インターフェイスを所有する WUA オブジェクトによって異なります。ICategory インターフェイスが IUpdate の Categories プロパティから返される場合は、IUpdate のローカライズ規則に従います。ICategory インターフェイスが IUpdateHistoryEntry2 の Categories プロパティから返される場合は、IUpdateHistoryEntry2 のローカライズ規則に従います。

vtbl 12 HRESULT get_Deadline(VARIANT* retval)

更新プログラムをインストールしなければならない期限の日付を取得します。

retvalVARIANT*out更新のインストール期限を格納した VARIANT を受け取る出力先へのポインタである。期限がない場合は空の VARIANT が返る。

解説(Remarks)

COM では、更新プログラムに期限がある場合、戻り値は VT_DATE 型で、期限を指定する DATE 値を格納します。それ以外の場合、戻り値は VT_EMPTY 型になります。

Microsoft .NET Framework では、更新プログラムに期限がない場合、戻り値は NULL になります。

vtbl 13 HRESULT get_DeltaCompressedContentAvailable(VARIANT_BOOL* retval)

更新プログラムの差分圧縮コンテンツがサーバー上で利用できるかどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*out差分圧縮コンテンツが利用可能かどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 14 HRESULT get_DeltaCompressedContentPreferred(VARIANT_BOOL* retval)

差分圧縮コンテンツが利用できる場合に、更新プログラムのダウンロードおよびインストールまたはアンインストールの際に差分圧縮コンテンツを優先するかどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*out差分圧縮コンテンツの使用が推奨されるかどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 15 HRESULT get_Description(LPWSTR* retval)

更新プログラムのローカライズされた説明を取得します。

retvalLPWSTR*out更新の説明文を受け取る文字列ポインタへのポインタである。

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

vtbl 16 HRESULT get_EulaAccepted(VARIANT_BOOL* retval)

更新プログラムに関連付けられた Microsoft ソフトウェアライセンス条項がコンピューターで承諾されているかどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*out使用許諾契約 (EULA) が承諾済みかどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 17 HRESULT get_EulaText(LPWSTR* retval)

更新プログラムに関連付けられた Microsoft ソフトウェアライセンス条項の、ローカライズされた完全なテキストを取得します。

retvalLPWSTR*out更新の使用許諾契約 (EULA) の本文を受け取る文字列ポインタへのポインタである。

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

vtbl 18 HRESULT get_HandlerID(LPWSTR* retval)

更新プログラムのインストールハンドラーを取得します。

retvalLPWSTR*out更新を処理するハンドラーの識別子を受け取る文字列ポインタへのポインタである。

解説(Remarks)

HandlerID プロパティの有効な値には、次のものがあります。

vtbl 19 HRESULT get_Identity(IUpdateIdentity** retval)

更新プログラムの一意の識別子を保持するインターフェイスを取得します。

retvalIUpdateIdentity**out更新の一意な識別情報を表す IUpdateIdentity インターフェイスを受け取るポインタへのポインタである。
vtbl 20 HRESULT get_Image(IImageInformation** retval)

更新プログラムに関連付けられたイメージに関する情報を保持するインターフェイスを取得します。

retvalIImageInformation**out更新に関連付けられた画像情報を表す IImageInformation インターフェイスを受け取るポインタへのポインタである。画像がない場合は NULL が返る。

戻り値

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

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

この API は、戻り値が S_OK の場合でも、出力として null ポインターを返すことがあります。

vtbl 21 HRESULT get_InstallationBehavior(IInstallationBehavior** retval)

更新プログラムのインストールオプションを保持するインターフェイスを取得します。

retvalIInstallationBehavior**out更新のインストール時の動作を表す IInstallationBehavior インターフェイスを受け取るポインタへのポインタである。

戻り値

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

解説(Remarks)

現在の更新プログラムがバンドルを表す場合、そのバンドルの InstallationBehavior プロパティは、バンドル内の子更新プログラムの InstallationBehavior プロパティによって決定されます。この API は、戻り値が S_OK の場合でも、出力として null ポインターを返すことがあります。

vtbl 22 HRESULT get_IsBeta(VARIANT_BOOL* retval)

更新プログラムがベータリリースかどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*out更新がベータ版かどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 23 HRESULT get_IsDownloaded(VARIANT_BOOL* retval)

更新プログラムのすべてのコンテンツがコンピューターにキャッシュされているかどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*out更新がダウンロード済みかどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 24 HRESULT get_IsHidden(VARIANT_BOOL* retval)

更新プログラムがユーザーによって非表示にされているかどうかを示す Boolean 値を取得します。(Get)

retvalVARIANT_BOOL*out更新が非表示に設定されているかどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。

解説(Remarks)

必須の更新プログラムを非表示にしようとすると、エラーが発生します。

vtbl 25 HRESULT put_IsHidden(VARIANT_BOOL value)

更新プログラムがユーザーによって非表示にされているかどうかを示す Boolean 値を取得します。(Put)

valueVARIANT_BOOLin更新を非表示に設定するかどうかを VARIANT_BOOL で指定する。

解説(Remarks)

必須の更新プログラムを非表示にしようとすると、エラーが発生します。

vtbl 26 HRESULT get_IsInstalled(VARIANT_BOOL* retval)

検索の実行時に更新プログラムがコンピューターにインストールされているかどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*out更新がインストール済みかどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 27 HRESULT get_IsMandatory(VARIANT_BOOL* retval)

更新プログラムのインストールが必須かどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*out更新が必須かどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。

解説(Remarks)

必須の更新プログラムを非表示にしようとすると、エラーが発生します。

必須の更新プログラムとは、Windows Update Agent (WUA) インフラストラクチャに対する更新プログラムです。WUA が動作を継続するために、すべての必須更新プログラムが必要とは限りません。ただし、これらの更新プログラムは、多くの場合パフォーマンスを向上させたり、WUA が提供できる製品の数を増やしたりします。すべての必須更新プログラムをインストールすることをお勧めします。

vtbl 28 HRESULT get_IsUninstallable(VARIANT_BOOL* retval)

ユーザーがコンピューターから更新プログラムをアンインストールできるかどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*out更新がアンインストール可能かどうかを表す VARIANT_BOOL を受け取る出力先へのポインタである。
vtbl 29 HRESULT get_Languages(IStringCollection** retval)

更新プログラムがサポートする言語を保持するインターフェイスを取得します。

retvalIStringCollection**out更新がサポートする言語の一覧を表す IStringCollection インターフェイスを受け取るポインタへのポインタである。

解説(Remarks)

このプロパティは、更新プログラム自体の言語を指します。更新プログラムのタイトルや説明に使用される言語は、必ずしも更新プログラム自体の言語とは限りません。

vtbl 30 HRESULT get_LastDeploymentChangeTime(DOUBLE* retval)

更新プログラムを配置するサーバー上での、更新プログラムの最終公開日を協定世界時 (UTC) の日時で取得します。

retvalDOUBLE*out更新の配置が最後に変更された日時 (DATE 値) を受け取る出力先へのポインタである。

解説(Remarks)

Windows XP を実行しているコンピューターでは、LastDeploymentChangeTime プロパティは、IUpdateApproval インターフェイスの CreationDate プロパティで取得される日時と同じ日時を取得します。CreationDate プロパティは、Windows Server 2003 を実行しているコンピューターで使用されます。

vtbl 31 HRESULT get_MaxDownloadSize(DECIMAL* retval)

更新プログラムの最大ダウンロードサイズを取得します。

retvalDECIMAL*out更新の最大ダウンロードサイズ (バイト数) を表す DECIMAL を受け取る出力先へのポインタである。

解説(Remarks)

更新プログラムの MinDownloadSize プロパティ分のコンテンツは常にダウンロードされます。ただし、MaxDownloadSize プロパティ分は常にダウンロードされるとは限りません。MaxDownloadSize プロパティ分は、更新プログラムを受け取るコンピューターの構成に基づいてダウンロードされます。

vtbl 32 HRESULT get_MinDownloadSize(DECIMAL* retval)

更新プログラムの最小ダウンロードサイズを取得します。

retvalDECIMAL*out更新の最小ダウンロードサイズ (バイト数) を表す DECIMAL を受け取る出力先へのポインタである。

解説(Remarks)

更新プログラムの MinDownloadSize プロパティ分のコンテンツは常にダウンロードされます。ただし、MaxDownloadSize プロパティ分は常にダウンロードされるとは限りません。MaxDownloadSize プロパティ分は、更新プログラムを受け取るコンピューターの構成に基づいてダウンロードされます。

vtbl 33 HRESULT get_MoreInfoUrls(IStringCollection** retval)

更新プログラムに関する詳細情報へのハイパーリンクを指定する、言語固有の文字列のコレクションを取得します。

retvalIStringCollection**out更新に関する詳細情報の URL 一覧を表す IStringCollection インターフェイスを受け取るポインタへのポインタである。
vtbl 34 HRESULT get_MsrcSeverity(LPWSTR* retval)

更新プログラムの Microsoft Security Response Center による重大度評価を取得します。

retvalLPWSTR*out更新の MSRC 深刻度 (例: Critical, Important) を受け取る文字列ポインタへのポインタである。

解説(Remarks)

以下は、更新プログラムによって修正されるセキュリティ問題に付与される可能性のある重大度評価です。これらの評価は、2002 年 11 月に Microsoft Security Response Center によって改訂されました。

用語 説明
Critical 悪用されると、ユーザーの操作なしにインターネットワームが拡散する可能性のあるセキュリティ問題。
Important 悪用されると、ユーザーのデータの機密性、完全性、可用性、または処理リソースの完全性や可用性が損なわれる可能性のあるセキュリティ問題。
Moderate 既定の構成、監査、悪用の困難さなどの要因により、悪用が大幅に緩和されるもの。
Low 悪用が極めて困難であるか、影響が最小限であるセキュリティ問題。
vtbl 35 HRESULT get_RecommendedCpuSpeed(INT* retval)

更新プログラムのインストールに推奨される CPU 速度をメガヘルツ (MHz) 単位で取得します。

retvalINT*out更新が推奨する CPU 速度 (MHz) を受け取る出力先へのポインタである。

解説(Remarks)

IUpdate インターフェイスの次のプロパティは、情報が利用できない場合に 0 (ゼロ) を返します。

vtbl 36 HRESULT get_RecommendedHardDiskSpace(INT* retval)

更新プログラムをインストールする前にハードディスク上に確保しておくことが推奨される空き容量を取得します。空き容量はメガバイト (MB) 単位で指定されます。

retvalINT*out更新が推奨するハードディスクの空き容量 (MB) を受け取る出力先へのポインタである。

解説(Remarks)

IUpdate インターフェイスの次のプロパティは、情報が利用できない場合に 0 (ゼロ) を返します。

vtbl 37 HRESULT get_RecommendedMemory(INT* retval)

更新プログラムをインストールする前にコンピューターで確保しておくことが推奨される物理メモリのサイズを取得します。物理メモリのサイズはメガバイト (MB) 単位で指定されます。

retvalINT*out更新が推奨するメモリ容量 (MB) を受け取る出力先へのポインタである。

解説(Remarks)

IUpdate インターフェイスの次のプロパティは、情報が利用できない場合に 0 (ゼロ) を返します。

vtbl 38 HRESULT get_ReleaseNotes(LPWSTR* retval)

更新プログラムのローカライズされたリリースノートを取得します。

retvalLPWSTR*out更新のリリースノートを受け取る文字列ポインタへのポインタである。

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

vtbl 39 HRESULT get_SecurityBulletinIDs(IStringCollection** retval)

更新プログラムに関連付けられたセキュリティ情報 ID を含む文字列値のコレクションを取得します。

retvalIStringCollection**out更新に関連するセキュリティ情報 (セキュリティ情報 ID) の一覧を表す IStringCollection インターフェイスを受け取るポインタへのポインタである。
vtbl 40 HRESULT get_SupersededUpdateIDs(IStringCollection** retval)

更新プログラムの識別子のコレクションを取得します。この識別子のコレクションは、この更新プログラムによって置き換えられる更新プログラムを指定します。

retvalIStringCollection**outこの更新によって置き換えられる更新の ID 一覧を表す IStringCollection インターフェイスを受け取るポインタへのポインタである。
vtbl 41 HRESULT get_SupportUrl(LPWSTR* retval)

更新プログラムの言語固有のサポート情報へのハイパーリンクを取得します。

retvalLPWSTR*out更新のサポートページの URL を受け取る文字列ポインタへのポインタである。

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

vtbl 42 HRESULT get_Type(UpdateType* retval)

更新プログラムの種類を取得します。

retvalUpdateType*out更新プログラムの種類を指定する UpdateType 列挙体のメンバー。
vtbl 43 HRESULT get_UninstallationNotes(LPWSTR* retval)

更新プログラムのアンインストールに関する注意事項を取得します。

retvalLPWSTR*out更新のアンインストールに関する注意事項を受け取る文字列ポインタへのポインタである。

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

vtbl 44 HRESULT get_UninstallationBehavior(IInstallationBehavior** retval)

更新プログラムのアンインストールオプションを保持するインターフェイスを取得します。

retvalIInstallationBehavior**out更新のアンインストール時の動作を表す IInstallationBehavior インターフェイスを受け取るポインタへのポインタである。

戻り値

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

解説(Remarks)

この API は、戻り値が S_OK の場合でも、出力として null ポインターを返すことがあります。

vtbl 45 HRESULT get_UninstallationSteps(IStringCollection** retval)

更新プログラムのアンインストール手順を保持するインターフェイスを取得します。

retvalIStringCollection**out更新の手動アンインストール手順の一覧を表す IStringCollection インターフェイスを受け取るポインタへのポインタである。

解説(Remarks)

IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher メソッドを使用して作成されている場合、このプロパティが返す情報は、UserLocale プロパティで指定された言語のものになります。これは、IUpdateSearcher の作成に使用したセッションの IUpdateSession2 インターフェイスの UserLocale プロパティです。

IUpdateSession2 の UserLocale プロパティで言語設定が指定されていない場合、または IUpdateSearcher インターフェイスが IUpdateSession::CreateUpdateSearcher を使用して作成されていない場合、このプロパティが返す情報は、ユーザーの既定のユーザーインターフェイス (UI) 言語のものになります。ユーザーの既定の UI 言語が利用できない場合、Windows Update Agent (WUA) はコンピューターの既定の UI 言語を使用します。コンピューターの既定の言語が利用できない場合、WUA は更新プログラムの提供元が推奨する言語を使用します。

vtbl 46 HRESULT get_KBArticleIDs(IStringCollection** retval)

更新プログラムに関連付けられた Microsoft サポート技術情報 (Knowledge Base) の記事 ID のコレクションを取得します。

retvalIStringCollection**out更新に関連する Microsoft サポート技術情報 (KB) の記事 ID 一覧を表す IStringCollection インターフェイスを受け取るポインタへのポインタである。
vtbl 47 HRESULT AcceptEula()

Windows Update に関連付けられた Microsoft ソフトウェアライセンス条項を承諾します。

戻り値

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

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

戻り値 説明
E_ACCESSDENIED
 このメソッドはリモートコンピューターから呼び出すことはできません。
WU_E_INVALID_OPERATION
 コンピューターが更新サイトにアクセスできませんでした。

(このメソッドは、インターフェイスを実装しているオブジェクトがロックダウンされている場合に WU_E_INVALID_OPERATION を返します。)
WU_E_EULA_UNAVAILABLE
 更新プログラムの Microsoft ソフトウェアライセンス条項が見つかりませんでした。
vtbl 48 HRESULT get_DeploymentAction(DeploymentAction* retval)

更新プログラムが配置される目的のアクションを取得します。

retvalDeploymentAction*out更新に対する配置アクション (DeploymentAction) を受け取る出力先へのポインタである。
vtbl 49 HRESULT CopyFromCache(LPWSTR path, VARIANT_BOOL toExtractCabFiles)

更新プログラムのコンテンツを指定されたパスにコピーします。

pathLPWSTRin更新プログラムのコンテンツのコピー先となる場所のパス。
toExtractCabFilesVARIANT_BOOLin

将来の使用のために予約されています。

toExtractCabFiles には VARIANT_TRUE または VARIANT_FALSE を設定する必要があります。

戻り値

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

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

戻り値 説明
E_ACCESSDENIED
 このメソッドはリモートコンピューターから呼び出すことはできません。
E_INVALIDARG
 パラメーターの値が無効です。
WU_E_INVALID_OPERATION
 コンピューターが更新サイトにアクセスできませんでした。

(このメソッドは、インターフェイスを実装しているオブジェクトがロックダウンされている場合に WU_E_INVALID_OPERATION を返します。)
WU_E_EULAS_DECLINED
 Microsoft ソフトウェアライセンス条項が承諾されていません。
WU_E_DM_NOTDOWNLOADED
 ファイルがダウンロードされていません。
WU_E_DM_INCORRECTFILEHASH
 ファイルのハッシュ検証に失敗しました。
COR_E_DIRECTORYNOTFOUND
 ファイルまたはディレクトリが見つかりませんでした。
STG_E_PATHNOTFOUND
 ファイルまたはディレクトリが見つかりませんでした。

解説(Remarks)

バンドルされた更新プログラムをコピーするには、この更新プログラムにバンドルされている個々の更新プログラムに対してこのメソッドを呼び出します。

注意 ダウンロード済みの更新プログラムをあるコンピューターから別のコンピューターへ移動する目的で IUpdate::CopyFromCache メソッドや IUpdate2::CopyToCache メソッドを使用することは、推奨もサポートもされていません。Windows Update Agent (WUA) が更新プログラムをダウンロードする際、特定のクライアントコンピューターに必要な更新プログラムのペイロードの一部のみをダウンロードすることがあります。必要となるペイロードの部分は、ハードウェアやソフトウェアの構成が似ているコンピューター同士であっても、コンピューターによって異なる場合が少なくありません。IUpdate2::CopyToCache は、提供されたファイルがそのコンピューターで Windows Update が通常ダウンロードするファイルと完全に一致する場合にのみ動作します。別のコンピューターで IUpdate::CopyFromCache を呼び出してファイルを取得した場合、それらのファイルは Windows Update が通常ダウンロードするファイルと一致しない可能性が高いため、IUpdate2::CopyToCache が失敗することがあります。
vtbl 50 HRESULT get_DownloadPriority(DownloadPriority* retval)

更新プログラムの推奨されるダウンロード優先度を取得します。

retvalDownloadPriority*out更新のダウンロード優先度 (DownloadPriority) を受け取る出力先へのポインタである。
vtbl 51 HRESULT get_DownloadContents(IUpdateDownloadContentCollection** retval)

更新プログラムのダウンロードコンテンツに関するファイル情報を取得します。

retvalIUpdateDownloadContentCollection**out更新プログラムに関連付けられたダウンロードコンテンツの URL を列挙できる IUpdateDownloadContentCollection。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUpdate "{6A92B07A-D821-4682-B423-5C805022CC4D}"
#usecom global IUpdate IID_IUpdate "{}"
#comfunc global IUpdate_get_Title                            7 var
#comfunc global IUpdate_get_AutoSelectOnWebSites             8 var
#comfunc global IUpdate_get_BundledUpdates                   9 sptr
#comfunc global IUpdate_get_CanRequireSource                 10 var
#comfunc global IUpdate_get_Categories                       11 sptr
#comfunc global IUpdate_get_Deadline                         12 var
#comfunc global IUpdate_get_DeltaCompressedContentAvailable  13 var
#comfunc global IUpdate_get_DeltaCompressedContentPreferred  14 var
#comfunc global IUpdate_get_Description                      15 var
#comfunc global IUpdate_get_EulaAccepted                     16 var
#comfunc global IUpdate_get_EulaText                         17 var
#comfunc global IUpdate_get_HandlerID                        18 var
#comfunc global IUpdate_get_Identity                         19 sptr
#comfunc global IUpdate_get_Image                            20 sptr
#comfunc global IUpdate_get_InstallationBehavior             21 sptr
#comfunc global IUpdate_get_IsBeta                           22 var
#comfunc global IUpdate_get_IsDownloaded                     23 var
#comfunc global IUpdate_get_IsHidden                         24 var
#comfunc global IUpdate_put_IsHidden                         25 int
#comfunc global IUpdate_get_IsInstalled                      26 var
#comfunc global IUpdate_get_IsMandatory                      27 var
#comfunc global IUpdate_get_IsUninstallable                  28 var
#comfunc global IUpdate_get_Languages                        29 sptr
#comfunc global IUpdate_get_LastDeploymentChangeTime         30 var
#comfunc global IUpdate_get_MaxDownloadSize                  31 var
#comfunc global IUpdate_get_MinDownloadSize                  32 var
#comfunc global IUpdate_get_MoreInfoUrls                     33 sptr
#comfunc global IUpdate_get_MsrcSeverity                     34 var
#comfunc global IUpdate_get_RecommendedCpuSpeed              35 var
#comfunc global IUpdate_get_RecommendedHardDiskSpace         36 var
#comfunc global IUpdate_get_RecommendedMemory                37 var
#comfunc global IUpdate_get_ReleaseNotes                     38 var
#comfunc global IUpdate_get_SecurityBulletinIDs              39 sptr
#comfunc global IUpdate_get_SupersededUpdateIDs              40 sptr
#comfunc global IUpdate_get_SupportUrl                       41 var
#comfunc global IUpdate_get_Type                             42 var
#comfunc global IUpdate_get_UninstallationNotes              43 var
#comfunc global IUpdate_get_UninstallationBehavior           44 sptr
#comfunc global IUpdate_get_UninstallationSteps              45 sptr
#comfunc global IUpdate_get_KBArticleIDs                     46 sptr
#comfunc global IUpdate_AcceptEula                           47
#comfunc global IUpdate_get_DeploymentAction                 48 var
#comfunc global IUpdate_CopyFromCache                        49 wstr,int
#comfunc global IUpdate_get_DownloadPriority                 50 var
#comfunc global IUpdate_get_DownloadContents                 51 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。