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

IUpdateCollection

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID07f7438c-7709-4ca5-b518-91279288134e継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

更新プログラムの順序付きリストを表します。

解説(Remarks)

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

メソッド 10

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

vtbl 7 HRESULT get_Item(INT index, IUpdate** retval)

コレクション内の IUpdate インターフェースを取得または設定します。(Get)

indexINTin取得する更新プログラムの 0 から始まるインデックスを指定する。
retvalIUpdate**out指定したインデックスの更新プログラム(IUpdate)を受け取るポインタである。
vtbl 8 HRESULT put_Item(INT index, IUpdate* value)

コレクション内の IUpdate インターフェースを取得または設定します。(Put)

indexINTin設定する位置の 0 から始まるインデックスを指定する。
valueIUpdate*in指定したインデックスに格納する更新プログラム(IUpdate)を渡す。
vtbl 9 HRESULT get__NewEnum(IUnknown** retval)

コレクションの列挙に使用できる IEnumVARIANT インターフェースを取得します。(IUpdateCollection.get__NewEnum)

retvalIUnknown**outコレクションを反復処理するための列挙子(IUnknown、内部的には IEnumVARIANT)を受け取るポインタである。
vtbl 10 HRESULT get_Count(INT* retval)

コレクション内の要素数を取得します。(IUpdateCollection.get_Count)

retvalINT*outコレクション内の更新プログラムの個数を受け取る INT へのポインタである。
vtbl 11 HRESULT get_ReadOnly(VARIANT_BOOL* retval)

更新プログラムコレクションが読み取り専用かどうかを示す Boolean 値を取得します。

retvalVARIANT_BOOL*outこのコレクションが読み取り専用かどうかを受け取る VARIANT_BOOL へのポインタである。
vtbl 12 HRESULT Add(IUpdate* value, INT* retval)

コレクションに項目を追加します。(IUpdateCollection.Add)

valueIUpdate*inコレクションに追加する IUpdate インターフェース。
retvalINT*outコレクションに追加されたインターフェースのインデックス。

戻り値

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

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

戻り値のコード 説明
E_POINTER
パラメーター値が無効または NULL です。
WU_E_NOT_SUPPORTED
コレクションが読み取り専用です。
vtbl 13 HRESULT Clear()

コレクションからすべての要素を削除します。(IUpdateCollection.Clear)

戻り値

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

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

戻り値のコード 説明
WU_E_NOT_SUPPORTED
コレクションが読み取り専用です。
vtbl 14 HRESULT Copy(IUpdateCollection** retval)

コレクションの読み取り/書き込み可能な浅いコピーを作成します。

retvalIUpdateCollection**outコレクションの読み取り/書き込み可能な浅いコピー。

戻り値

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

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

戻り値のコード 説明
E_POINTER
パラメーター値が無効または NULL です。
E_ACCESSDENIED
このメソッドはリモートコンピューターから呼び出すことはできません。
vtbl 15 HRESULT Insert(INT index, IUpdate* value)

指定した位置にコレクションへ項目を挿入します。(IUpdateCollection.Insert)

indexINTin新しいインターフェースが挿入される位置。
valueIUpdate*in挿入される IUpdate インターフェース。

戻り値

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

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

戻り値のコード 説明
E_POINTER
パラメーター値が無効または NULL です。
WU_E_NOT_SUPPORTED
コレクションが読み取り専用です。
WU_E_INVALIDINDEX
インデックスが無効です。
vtbl 16 HRESULT RemoveAt(INT index)

指定したインデックスの項目をコレクションから削除します。(IUpdateCollection.RemoveAt)

indexINTin削除するインターフェースのインデックス。

戻り値

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

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

戻り値のコード 説明
WU_E_NOT_SUPPORTED
コレクションが読み取り専用です。
WU_E_INVALIDINDEX
インデックスが無効です。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUpdateCollection "{07F7438C-7709-4CA5-B518-91279288134E}"
#usecom global IUpdateCollection IID_IUpdateCollection "{13639463-00DB-4646-803D-528026140D88}"
#comfunc global IUpdateCollection_get_Item      7 int,sptr
#comfunc global IUpdateCollection_put_Item      8 int,sptr
#comfunc global IUpdateCollection_get__NewEnum  9 sptr
#comfunc global IUpdateCollection_get_Count     10 var
#comfunc global IUpdateCollection_get_ReadOnly  11 var
#comfunc global IUpdateCollection_Add           12 sptr,var
#comfunc global IUpdateCollection_Clear         13
#comfunc global IUpdateCollection_Copy          14 sptr
#comfunc global IUpdateCollection_Insert        15 int,sptr
#comfunc global IUpdateCollection_RemoveAt      16 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。