ホーム › Devices.Tapi › IEnumDirectoryObject

IEnumDirectoryObject

COM

IID06c9b64a-306d-11d1-9774-00c04fd91ac0継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

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

メソッド 4

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

vtbl 3 HRESULT Next(DWORD celt, ITDirectoryObject** pVal, DWORD* pcFetched)

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

celt	DWORD	in	要求する要素の数。
pVal	ITDirectoryObject**	out	ITDirectoryObject インターフェイスへのポインター。
pcFetched	DWORD*	inoutoptional	実際に返された要素の数へのポインター。celt が 1 の場合は NULL を指定できます。

戻り値

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

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

解説(Remarks)

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

vtbl 4 HRESULT Reset()

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

戻り値

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

リターンコード	説明
S_OK	メソッドは成功しました。

vtbl 5 HRESULT Skip(DWORD celt)

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

celt

DWORD

スキップする要素の数。

戻り値

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

リターンコード	説明
S_OK	スキップした要素の数は celt でした。
S_FALSE	スキップした要素の数が celt ではなかったことを示します。

vtbl 6 HRESULT Clone(IEnumDirectoryObject** ppEnum)

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

ppEnum

IEnumDirectoryObject**

out

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

戻り値

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

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

解説(Remarks)

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