ホーム › Devices.Tapi › IEnumAgentSession

IEnumAgentSession

COM

📘 Microsoft Learn (日本語) · English

IID5afc314e-4bcc-11d1-bf80-00805fc147d3継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumAgentSession インターフェイス (tapi3cc.h) は、ITAgentSession インターフェイスに対する COM 標準の列挙メソッドを提供します。

メソッド 4

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

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

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

celt	DWORD	in	要求する要素の数。
ppElements	ITAgentSession**	out	ITAgentSession インターフェイスへのポインター。
pceltFetched	DWORD*	out	実際に取得された要素の数へのポインター。celt が 1 の場合は NULL にすることができます。

戻り値

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

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

解説(Remarks)

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

vtbl 4 HRESULT Reset()

IEnumAgentSession::Reset メソッド (tapi3cc.h) は、列挙シーケンスを先頭にリセットします。

戻り値

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

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

vtbl 5 HRESULT Skip(DWORD celt)

IEnumAgentSession インターフェイス (tapi3cc.h) は、列挙シーケンス内の次の指定された数の要素をスキップします。

celt

DWORD

スキップする要素の数。

戻り値

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

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

vtbl 6 HRESULT Clone(IEnumAgentSession** ppEnum)

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

ppEnum

IEnumAgentSession**

out

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

戻り値

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

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

解説(Remarks)

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