IEnumLocation

COM

IID0c4d8f01-8ddb-11d1-a09e-00805fc147d3継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumLocation インターフェースは、ITLocationInfo インターフェースに対する COM 標準の列挙メソッドを提供します。ITAddressTranslation::EnumerateLocations メソッドは IEnumLocation へのポインターを返します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, ITLocationInfo** ppElements, DWORD* pceltFetched)

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

celt	DWORD	in	要求する要素数。
ppElements	ITLocationInfo**	out	ITLocationInfo ポインターへのポインター。
pceltFetched	DWORD*	inoutoptional	実際に提供された要素数へのポインター。celt が 1 の場合は NULL でもかまいません。

戻り値

このメソッドは次のいずれかの値を返すことができます。

戻り値	説明
S_OK	メソッドは celt 個の要素を返しました。
S_FALSE	残りの要素数が celt より少なくなっていました。
E_POINTER	ppElements パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

解説(Remarks)

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

vtbl 4 HRESULT Reset()

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

戻り値

このメソッドは次のいずれかの値を返すことができます。

戻り値	説明
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

vtbl 5 HRESULT Skip(DWORD celt)

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

celt

DWORD

スキップする要素数。

戻り値

このメソッドは次のいずれかの値を返すことができます。

戻り値	説明
S_OK	スキップされた要素数は celt でした。
S_FALSE	スキップされた要素数は celt ではありませんでした。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

vtbl 6 HRESULT Clone(IEnumLocation** ppEnum)

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

ppEnum

IEnumLocation**

out

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

戻り値

このメソッドは次のいずれかの値を返すことができます。

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

解説(Remarks)

TAPI は、IEnumLocation::Clone が返す IEnumLocation インターフェースに対して AddRef メソッドを呼び出します。アプリケーションは、 IEnumLocation インターフェースに対して 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_IEnumLocation "{0C4D8F01-8DDB-11D1-A09E-00805FC147D3}"
#usecom global IEnumLocation IID_IEnumLocation "{}"
#comfunc global IEnumLocation_Next   3 int,sptr,var
#comfunc global IEnumLocation_Reset  4
#comfunc global IEnumLocation_Skip   5 int
#comfunc global IEnumLocation_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumLocation "{0C4D8F01-8DDB-11D1-A09E-00805FC147D3}"
#usecom global IEnumLocation IID_IEnumLocation "{}"
#comfunc global IEnumLocation_Next   3 int,sptr,sptr
#comfunc global IEnumLocation_Reset  4
#comfunc global IEnumLocation_Skip   5 int
#comfunc global IEnumLocation_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。