IEnumDialableAddrs

COM

IID34621d70-6cff-11d1-aff7-00c04fc31fee継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumDialableAddrs インターフェイスは、ディレクトリ内で利用可能なダイヤル可能アドレスを検出して使用するための、COM 標準の列挙メソッドを提供します。ITDirectoryObject::EnumerateDialableAddrs メソッドは、このインターフェイスへのポインターを返します。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, LPWSTR* ppElements, DWORD* pcFetched)

Next メソッドは、列挙シーケンス内の次の指定された数の要素を取得します。(IEnumDialableAddrs.Next)

celt	DWORD	in	要求する要素の数。
ppElements	LPWSTR*	out	アドレスリストの BSTR 表現へのポインター。
pcFetched	DWORD*	inoutoptional	実際に提供された要素の数へのポインター。celt が 1 の場合は NULL でもかまいません。

戻り値

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

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

解説(Remarks)

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

vtbl 4 HRESULT Reset()

Reset メソッドは、列挙シーケンスの先頭にリセットします。(IEnumDialableAddrs.Reset)

戻り値

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

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

vtbl 5 HRESULT Skip(DWORD celt)

Skip メソッドは、列挙シーケンス内の次の指定された数の要素をスキップします。(IEnumDialableAddrs.Skip)

celt

DWORD

スキップする要素の数。

戻り値

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

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

vtbl 6 HRESULT Clone(IEnumDialableAddrs** ppEnum)

Clone メソッドは、現在の列挙子と同じ列挙状態を持つ別の列挙子を作成します。(IEnumDialableAddrs.Clone)

ppEnum

IEnumDialableAddrs**

out

新しい IEnumDialableAddrs オブジェクトへのポインター。

戻り値

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

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

解説(Remarks)

TAPI は、IEnumDialableAddrs::Clone によって返された IEnumDialableAddrs インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、そのインターフェイスに関連付けられたリソースを解放するために、 IEnumDialableAddrs インターフェイスに対して 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_IEnumDialableAddrs "{34621D70-6CFF-11D1-AFF7-00C04FC31FEE}"
#usecom global IEnumDialableAddrs IID_IEnumDialableAddrs "{}"
#comfunc global IEnumDialableAddrs_Next   3 int,var,var
#comfunc global IEnumDialableAddrs_Reset  4
#comfunc global IEnumDialableAddrs_Skip   5 int
#comfunc global IEnumDialableAddrs_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumDialableAddrs "{34621D70-6CFF-11D1-AFF7-00C04FC31FEE}"
#usecom global IEnumDialableAddrs IID_IEnumDialableAddrs "{}"
#comfunc global IEnumDialableAddrs_Next   3 int,sptr,sptr
#comfunc global IEnumDialableAddrs_Reset  4
#comfunc global IEnumDialableAddrs_Skip   5 int
#comfunc global IEnumDialableAddrs_Clone  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。