ホーム › Devices.Tapi › IEnumBstr

IEnumBstr

COM

📘 Microsoft Learn (日本語) · English

IID35372049-0bc6-11d2-a033-00c04fb6809f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumBstr インターフェイスは、BSTR 文字列を列挙するための COM 標準メソッドを提供します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, LPWSTR* ppStrings, DWORD* pceltFetched)

Next メソッドは、列挙シーケンス内で指定した数の次の要素を取得します。このメソッドは Visual Basic およびスクリプト言語からは隠されています。(IEnumBstr.Next)

celt	DWORD	in	要求する要素の数。
ppStrings	LPWSTR*	out	返される BSTR ポインターのリストへのポインター。
pceltFetched	DWORD*	inoutoptional	実際に返された要素数へのポインター。celt が 1 の場合は NULL を指定できます。

戻り値

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

戻り値コード	説明
S_OK	メソッドは celt 個の要素を返しました。
S_FALSE	残りの要素数が celt より少なかった。
E_POINTER	ppStrings パラメーターが有効なポインターではありません。

解説(Remarks)

アプリケーションは、ppStrings パラメーターに割り当てられたメモリを解放するために SysFreeString を使用する必要があります。

vtbl 4 HRESULT Reset()

Reset メソッドは、列挙シーケンスの先頭にリセットします。このメソッドは Visual Basic およびスクリプト言語からは隠されています。(IEnumBstr.Reset)

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。

vtbl 5 HRESULT Skip(DWORD celt)

Skip メソッドは、列挙シーケンス内で指定した数の次の要素をスキップします。このメソッドは Visual Basic およびスクリプト言語からは隠されています。(IEnumBstr.Skip)

celt

DWORD

スキップする要素の数。

戻り値

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

戻り値コード	説明
S_OK	スキップした要素数は celt でした。
S_FALSE	スキップした要素数は celt ではありませんでした。

vtbl 6 HRESULT Clone(IEnumBstr** ppEnum)

Clone メソッドは、現在の列挙子と同じ列挙状態を持つ別の列挙子を作成します。このメソッドは Visual Basic およびスクリプト言語からは隠されています。(IEnumBstr.Clone)

ppEnum

IEnumBstr**

out

新しい IEnumBstr インターフェイスへのポインター。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	ppEnum パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_UNEXPECTED	不明な理由で失敗しました。

解説(Remarks)

TAPI は、このメソッドが返す IEnumBstr インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、IEnumBstr インターフェイスに関連付けられたリソースを解放するために、そのインターフェイスに対して Release メソッドを呼び出す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IEnumBstr "{35372049-0BC6-11D2-A033-00C04FB6809F}"
#usecom global IEnumBstr IID_IEnumBstr "{}"
#comfunc global IEnumBstr_Next   3 int,var,var
#comfunc global IEnumBstr_Reset  4
#comfunc global IEnumBstr_Skip   5 int
#comfunc global IEnumBstr_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumBstr "{35372049-0BC6-11D2-A033-00C04FB6809F}"
#usecom global IEnumBstr IID_IEnumBstr "{}"
#comfunc global IEnumBstr_Next   3 int,sptr,sptr
#comfunc global IEnumBstr_Reset  4
#comfunc global IEnumBstr_Skip   5 int
#comfunc global IEnumBstr_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。