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

IStringCollection

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

公式ドキュメント

順序付けられた文字列のリストを表します。

解説(Remarks)

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

メソッド 10

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

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

コレクション内の文字列を取得または設定します。(Get)

indexINTin取得する要素の 0 始まりのインデックスを指定する。
retvalLPWSTR*out指定インデックスの文字列を受け取る文字列ポインタへのポインタである。
vtbl 8 HRESULT put_Item(INT index, LPWSTR value)

コレクション内の文字列を取得または設定します。(Put)

indexINTin設定する要素の 0 始まりのインデックスを指定する。
valueLPWSTRin指定インデックスに設定する文字列を指定する。
vtbl 9 HRESULT get__NewEnum(IUnknown** retval)

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

retvalIUnknown**outコレクションを反復処理するための列挙子を表す IUnknown インターフェイスを受け取るポインタへのポインタである。
vtbl 10 HRESULT get_Count(INT* retval)

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

retvalINT*outコレクション内の文字列の数を受け取る出力先へのポインタである。
vtbl 11 HRESULT get_ReadOnly(VARIANT_BOOL* retval)

コレクションが読み取り専用かどうかを示す Boolean 値を取得します。

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

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

valueLPWSTRinコレクションに追加する文字列。
retvalINT*outコレクション内で追加されたインターフェイスのインデックス。

戻り値

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

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

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

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

戻り値

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

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

リターンコード 説明
WU_E_NOT_SUPPORTED
 コレクションは読み取り専用です。
vtbl 14 HRESULT Copy(IStringCollection** retval)

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

retvalIStringCollection**outコレクションの読み取り/書き込み可能なディープコピー。

戻り値

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

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

リターンコード 説明
E_POINTER
 パラメーター値が無効または NULL です。
vtbl 15 HRESULT Insert(INT index, LPWSTR value)

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

indexINTin新しい文字列を挿入する位置。
valueLPWSTRin挿入する文字列。

戻り値

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

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

リターンコード 説明
WU_E_NOT_SUPPORTED
 コレクションは読み取り専用です。
WU_E_INVALIDINDEX
 インデックスが無効です。
vtbl 16 HRESULT RemoveAt(INT index)

指定したインデックスの項目をコレクションから削除します。(IStringCollection.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_IStringCollection "{EFF90582-2DDC-480F-A06D-60F3FBC362C3}"
#usecom global IStringCollection IID_IStringCollection "{72C97D74-7C3B-40AE-B77D-ABDB22EBA6FB}"
#comfunc global IStringCollection_get_Item      7 int,var
#comfunc global IStringCollection_put_Item      8 int,wstr
#comfunc global IStringCollection_get__NewEnum  9 sptr
#comfunc global IStringCollection_get_Count     10 var
#comfunc global IStringCollection_get_ReadOnly  11 var
#comfunc global IStringCollection_Add           12 wstr,var
#comfunc global IStringCollection_Clear         13
#comfunc global IStringCollection_Copy          14 sptr
#comfunc global IStringCollection_Insert        15 int,wstr
#comfunc global IStringCollection_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 不要)。