IValueMap

COMIDispatch (デュアル)

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

IID03837534-098b-11d8-9414-505054503030継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

名前と値のペアのコレクションを管理します。このインターフェイスを取得するには、次のいずれかのプロパティまたはメソッドにアクセスします:IDataCollector::SetXmlIDataCollectorSet::CommitIDataCollectorSet::SetXmlITraceDataProvider::KeywordsAllITraceDataProvider::KeywordsAnyITraceDataProvider::LevelITraceDataProvider::Properties

メソッド 14

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

vtbl 7 HRESULT get_Count(INT* retVal)

コレクション内の項目数を取得します。(IValueMap.get_Count)

retVal

INT*

out

現在の要素数を受け取るポインタである。

vtbl 8 HRESULT get_Item(VARIANT index, IValueMapItem** value)

コレクションから要求された項目を取得します。(IValueMap.get_Item)

index	VARIANT	in	取得する要素のインデックスまたはキーを表す VARIANT を指定する。
value	IValueMapItem**	out	指定した値マップ項目を表す IValueMapItem を受け取るポインタである。

解説(Remarks)

このプロパティは、オブジェクトの既定のプロパティです。

vtbl 9 HRESULT get__NewEnum(IUnknown** retVal)

列挙へのインターフェイスを取得します。(IValueMap.get__NewEnum)

retVal

IUnknown**

out

コレクションを反復処理する列挙子(IEnumVARIANT)を受け取るポインタである。

解説(Remarks)

このプロパティは C++ プログラマーが使用します。

列挙は、呼び出し時点でのコレクションのスナップショットです。

列挙の項目は、型が VT_UNKNOWN のバリアントです。IValueMapItem インターフェイスを照会するには、バリアントの punkVal メンバーを使用します。

vtbl 10 HRESULT get_Description(LPWSTR* description)

コレクションの説明を取得または設定します。(Get)

description

LPWSTR*

out

現在の説明文を受け取るポインタである。

vtbl 11 HRESULT put_Description(LPWSTR description)

コレクションの説明を取得または設定します。(Put)

description

LPWSTR

説明文を設定する。

vtbl 12 HRESULT get_Value(VARIANT* Value)

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

Value

VARIANT*

out

値マップ全体の値を表す VARIANT を受け取るポインタである。

解説(Remarks)

IValueMap::ValueMapType プロパティの値に応じて、この値はコレクション内のいずれかの値、またはコレクション内のすべての項目の値を OR 演算子で結合して得られる値のいずれかになります。

ValueMapType 列挙が plaIndex、plaFlag、または plaFlagArray の場合、バリアント型は VT_UI8 です。

ValueMapType 列挙が plaValidation の場合、バリアント型は VT_UI4 です。

vtbl 13 HRESULT put_Value(VARIANT Value)

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

Value

VARIANT

値マップ全体に設定する値を表す VARIANT を指定する。

解説(Remarks)

ValueMapType 列挙が plaIndex、plaFlag、または plaFlagArray の場合、バリアント型は VT_UI8 です。

ValueMapType 列挙が plaValidation の場合、バリアント型は VT_UI4 です。

vtbl 14 HRESULT get_ValueMapType(ValueMapType* type)

コレクション内の項目の型を取得または設定します。(Get)

type

ValueMapType*

out

値マップの種類を受け取るポインタである。

vtbl 15 HRESULT put_ValueMapType(ValueMapType type)

コレクション内の項目の型を取得または設定します。(Put)

type

ValueMapType

値マップの種類を指定する。

vtbl 16 HRESULT Add(VARIANT value)

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

value

VARIANT

コレクションに追加する IValueMapItem インターフェイスの IDispatch インターフェイス。バリアント型は VT_DISPATCH です。

文字列値または整数値を追加することもできます。値が整数(バリアント型が VT_I4、VT_UI4、VT_I8、または VT_UI8)の場合、PLA は指定された値を持つ項目を追加します。

値が文字列(バリアント型が VT_BSTR)の場合、PLA は文字列を整数に変換しようとします。変換に成功した場合、PLA は指定された整数値を持つ項目を追加します。PLA が文字列を変換できない場合、PLA は文字列に一致するキーをコレクション内で検索します。見つかった場合、PLA はその項目を有効にします。見つからない場合、追加は失敗します。

戻り値

成功した場合は S_OK を返します。

vtbl 17 HRESULT Remove(VARIANT value)

コレクションから項目を削除します。

value

VARIANT

コレクションから削除する項目の 0 から始まるインデックス。バリアント型は VT_I4、VT_UI4、または VT_DISPATCH のいずれかです。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

バリアント型が VT_DISPATCH の場合は、削除する IValueMapItem インターフェイスの IDispatch インターフェイスを渡します。

vtbl 18 HRESULT Clear()

コレクションからすべての項目を削除します。

戻り値

成功した場合は S_OK を返します。

vtbl 19 HRESULT AddRange(IValueMap* map)

コレクションに 1 つ以上の項目を追加します。

map

IValueMap*

inoptional

このコレクションに追加する項目のコレクションを含む IValueMap インターフェイス。

戻り値

成功した場合は S_OK を返します。

vtbl 20 HRESULT CreateValueMapItem(IValueMapItem** Item)

値マップ項目を作成します。

Item

IValueMapItem**

out

名前と値のペアを定義するために使用する IValueMapItem インターフェイス。

戻り値

成功した場合は S_OK を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IValueMap "{03837534-098B-11D8-9414-505054503030}"
#usecom global IValueMap IID_IValueMap "{}"
#comfunc global IValueMap_get_Count           7 var
#comfunc global IValueMap_get_Item            8 int,sptr
#comfunc global IValueMap_get__NewEnum        9 sptr
#comfunc global IValueMap_get_Description     10 var
#comfunc global IValueMap_put_Description     11 wstr
#comfunc global IValueMap_get_Value           12 var
#comfunc global IValueMap_put_Value           13 int
#comfunc global IValueMap_get_ValueMapType    14 var
#comfunc global IValueMap_put_ValueMapType    15 int
#comfunc global IValueMap_Add                 16 int
#comfunc global IValueMap_Remove              17 int
#comfunc global IValueMap_Clear               18
#comfunc global IValueMap_AddRange            19 sptr
#comfunc global IValueMap_CreateValueMapItem  20 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IValueMap "{03837534-098B-11D8-9414-505054503030}"
#usecom global IValueMap IID_IValueMap "{}"
#comfunc global IValueMap_get_Count           7 sptr
#comfunc global IValueMap_get_Item            8 int,sptr
#comfunc global IValueMap_get__NewEnum        9 sptr
#comfunc global IValueMap_get_Description     10 sptr
#comfunc global IValueMap_put_Description     11 wstr
#comfunc global IValueMap_get_Value           12 sptr
#comfunc global IValueMap_put_Value           13 int
#comfunc global IValueMap_get_ValueMapType    14 sptr
#comfunc global IValueMap_put_ValueMapType    15 int
#comfunc global IValueMap_Add                 16 int
#comfunc global IValueMap_Remove              17 int
#comfunc global IValueMap_Clear               18
#comfunc global IValueMap_AddRange            19 sptr
#comfunc global IValueMap_CreateValueMapItem  20 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。