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

IStringTable

COM
📘 Microsoft Learn (日本語) · English
IIDde40b7a4-0f65-11d2-8e25-00c04f8ecd78継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IStringTable インターフェースは MMC 1.1 で導入されました。

メソッド 7

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT AddString(LPWSTR pszAdd, DWORD* pStringID)

スナップインがスナップインの文字列テーブルに文字列を追加できるようにします。

pszAddLPWSTRin文字列テーブルに追加する文字列。
pStringIDDWORD*out文字列テーブルに追加された文字列の ID へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

解説(Remarks)

文字列テーブル内の文字列は参照カウントされます。たとえば、文字列 "My Text" を文字列テーブルに追加すると、たとえば 1234 という ID が返されます。"My Text" を文字列テーブルに 2 回目に追加すると、再び 1234 という ID が返され、その文字列の内部参照カウントがインクリメントされます。"My Text" をスナップインの文字列テーブルから完全に削除するには、 IStringTable::DeleteString を 2 回呼び出すか、 IStringTable::DeleteAllStrings を 1 回呼び出す必要があります。

IStringTable::AddString は、呼び出しが成功した場合に 0 以外の文字列 ID を返します。したがって、スナップインは 0 を未割り当ての ID を示す値として安全に使用できます。

vtbl 4 HRESULT GetString(DWORD StringID, DWORD cchBuffer, LPWSTR lpBuffer, DWORD* pcchOut)

スナップインがスナップインの文字列テーブルから文字列を取得できるようにします。

StringIDDWORDinスナップインの文字列テーブルから取得する文字列の ID。
cchBufferDWORDinlpBuffer 内の文字数。
lpBufferLPWSTRout文字列を格納するバッファーへのポインター。
pcchOutDWORD*out取得された文字列の文字数(NULL 終端文字を含まない)。書き込まれた文字数が不要な場合は、このパラメーターに NULL を渡します。

戻り値

このメソッドは次のいずれかの値を返します。

解説(Remarks)

lpBuffer が StringID に対応する文字列全体を格納できるだけの大きさでない場合、収まる分だけの文字列がバッファーにコピーされ、NULL で終端されます。

vtbl 5 HRESULT GetStringLength(DWORD StringID, DWORD* pcchString)

スナップインがスナップインの文字列テーブル内の文字列の長さを取得できるようにします。

StringIDDWORDin長さを取得する文字列の識別子。
pcchStringDWORD*outスナップインの文字列テーブル内の指定された文字列の文字数(終端文字を含まない)。

戻り値

このメソッドは次のいずれかの値を返します。

解説(Remarks)

このメソッドを使用して、 IStringTable::GetString に必要なバッファーのサイズを判断します。

vtbl 6 HRESULT DeleteString(DWORD StringID)

スナップインがスナップインの文字列テーブルから指定した文字列を削除できるようにします。

StringIDDWORDinスナップインの文字列テーブルから削除する文字列。

戻り値

このメソッドは次のいずれかの値を返します。

解説(Remarks)

文字列テーブル内の文字列は参照カウントされます。たとえば、文字列 "My Text" を文字列テーブルに追加すると、たとえば 1234 という ID が返されます。"My Text" を文字列テーブルに 2 回目に追加すると、再び 1234 という ID が返され、その文字列の内部参照カウントがインクリメントされます。"My Text" をスナップインの文字列テーブルから完全に削除するには、IStringTable::DeleteString を 2 回呼び出す必要があります。

vtbl 7 HRESULT DeleteAllStrings()

IStringTable::DeleteAllStrings メソッドは、スナップインがスナップインの文字列テーブルからすべての文字列を削除できるようにします。

戻り値

このメソッドは次のいずれかの値を返します。

解説(Remarks)

このメソッドは、各文字列の参照カウントに関係なく、スナップインの文字列テーブルからすべての文字列を削除します。

vtbl 8 HRESULT FindString(LPWSTR pszFind, DWORD* pStringID)

スナップインがスナップインの文字列テーブル内の文字列を検索できるようにします。

pszFindLPWSTRin文字列テーブル内で検索する文字列。
pStringIDDWORD*out文字列テーブル内で見つかった文字列の ID へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

vtbl 9 HRESULT Enumerate(IEnumString** ppEnum)

スナップインの文字列テーブル内の文字列を返すことができる列挙子上の IEnumString インターフェースへのポインターを提供します。

ppEnumIEnumString**out列挙子へのインターフェースポインターを受け取る IEnumString* ポインター変数のアドレス。エラーが発生した場合、ppEnum は NULL に設定されます。ppEnum が NULL 以外の場合、MMC の IEnumString 実装は *ppEnum に対して IUnknown::AddRef を呼び出します。インターフェースが不要になったら、スナップインは IUnknown::Release を呼び出す必要があります。

戻り値

このメソッドは次のいずれかの値を返します。

解説(Remarks)

返される IEnumString 列挙は、列挙が取得された時点における基になる文字列テーブル内の文字列コレクションのスナップショットを表します。IEnumString::Reset も IEnumString::Clone も、コレクションの新しいスナップショットを取得しません。

IEnumString の実装は、返す文字列のメモリを割り当てるために既定の OLE タスクメモリアロケーターを使用します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IStringTable "{DE40B7A4-0F65-11D2-8E25-00C04F8ECD78}"
#usecom global IStringTable IID_IStringTable "{}"
#comfunc global IStringTable_AddString         3 wstr,var
#comfunc global IStringTable_GetString         4 int,int,var,var
#comfunc global IStringTable_GetStringLength   5 int,var
#comfunc global IStringTable_DeleteString      6 int
#comfunc global IStringTable_DeleteAllStrings  7
#comfunc global IStringTable_FindString        8 wstr,var
#comfunc global IStringTable_Enumerate         9 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。