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

IUpdateSession

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

公式ドキュメント

呼び出し側が更新プログラムに関連する操作を実行できるセッションを表します。たとえば、このインターフェイスは、呼び出し側が検索、ダウンロード、インストール、またはアンインストールの操作を実行するセッションを表します。(IUpdateSession)

解説(Remarks)

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

メソッド 8

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

vtbl 7 HRESULT get_ClientApplicationID(LPWSTR* retval)

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

retvalLPWSTR*outこのセッションに設定されているクライアントアプリケーション識別子を受け取る文字列ポインタである。

解説(Remarks)

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

vtbl 8 HRESULT put_ClientApplicationID(LPWSTR value)

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

valueLPWSTRinこのセッションを識別するために設定するクライアントアプリケーション識別子の文字列を指定する。

解説(Remarks)

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

vtbl 9 HRESULT get_ReadOnly(VARIANT_BOOL* retval)

セッションオブジェクトが読み取り専用かどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*outこのセッションが読み取り専用かどうかを受け取る VARIANT_BOOL へのポインタである。
vtbl 10 HRESULT get_WebProxy(IWebProxy** retval)

サーバーへのアクセスに使用されるプロキシ設定を取得および設定します。(Get)

retvalIWebProxy**outこのセッションで使用される Web プロキシ設定を受け取る IWebProxy へのポインタである。
vtbl 11 HRESULT put_WebProxy(IWebProxy* value)

サーバーへのアクセスに使用されるプロキシ設定を取得および設定します。(Put)

valueIWebProxy*inこのセッションで使用する Web プロキシ設定を指定する IWebProxy へのポインタである。NULL を指定するとシステム既定のプロキシが使用される。
vtbl 12 HRESULT CreateUpdateSearcher(IUpdateSearcher** retval)

このセッションの IUpdateSearcher インターフェイスを返します。

retvalIUpdateSearcher**outこのセッションの IUpdateSearcher インターフェイス。

戻り値

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

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

戻りコード 説明
E_INVALIDARG
 パラメーターの値が無効です。

解説(Remarks)

IUpdateSearcher インターフェイスは、UpdateSearcher コクラスを使用して作成することもできます。

vtbl 13 HRESULT CreateUpdateDownloader(IUpdateDownloader** retval)

このセッションの IUpdateDownloader インターフェイスを返します。

retvalIUpdateDownloader**outこのセッションの IUpdateDownloader インターフェイス。

戻り値

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

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

戻りコード 説明
E_INVALIDARG
 パラメーターの値が無効です。
E_ACCESSDENIED
 このメソッドはリモートコンピューターから呼び出すことはできません。

解説(Remarks)

IUpdateDownloader インターフェイスは、UpdateDownloader コクラスを使用して作成することもできます。

vtbl 14 HRESULT CreateUpdateInstaller(IUpdateInstaller** retval)

このセッションの IUpdateInstaller インターフェイスを返します。

retvalIUpdateInstaller**outこのセッションの IUpdateInstaller インターフェイス。

戻り値

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

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

戻りコード 説明
E_INVALIDARG
 パラメーターの値が無効です。
E_ACCESSDENIED
 このメソッドはリモートコンピューターから呼び出すことはできません。

解説(Remarks)

IUpdateInstaller インターフェイスは、UpdateInstaller コクラスを使用して作成することもできます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUpdateSession "{816858A4-260D-4260-933A-2585F1ABC76B}"
#usecom global IUpdateSession IID_IUpdateSession "{4CB43D7F-7EEE-4906-8698-60DA1C38F2FE}"
#comfunc global IUpdateSession_get_ClientApplicationID  7 var
#comfunc global IUpdateSession_put_ClientApplicationID  8 wstr
#comfunc global IUpdateSession_get_ReadOnly             9 var
#comfunc global IUpdateSession_get_WebProxy             10 sptr
#comfunc global IUpdateSession_put_WebProxy             11 sptr
#comfunc global IUpdateSession_CreateUpdateSearcher     12 sptr
#comfunc global IUpdateSession_CreateUpdateDownloader   13 sptr
#comfunc global IUpdateSession_CreateUpdateInstaller    14 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。