Win32 API 日本語リファレンス
ホーム › System.Com › IEnumConnections

IEnumConnections

COM
📘 Microsoft Learn (日本語) · English
IIDb196b287-bab4-101a-b69c-00aa00341d07継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

接続可能オブジェクトの現在の接続を列挙します。

解説(Remarks)

接続可能オブジェクトは、次の機能をサポートします。

メソッド 4

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

vtbl 3 HRESULT Next(DWORD cConnections, CONNECTDATA* rgcd, DWORD* pcFetched)

列挙シーケンス内の指定された数の項目を取得します。(IEnumConnections.Next)

cConnectionsDWORDin取得する項目の数。シーケンスに残っている項目が要求された数より少ない場合、このメソッドは残りの要素を取得します。
rgcdCONNECTDATA*out

列挙された項目の配列。

メモリの割り当ては列挙子が行い、その解放は呼び出し元の責任です。celt が 1 より大きい場合、呼び出し元は解放すべきポインタの数を知るために、pceltFetched に渡す NULL 以外のポインタも渡す必要があります。

pcFetchedDWORD*out取得された項目の数。このパラメータは常に、要求された項目の数以下になります。

戻り値

要求された数の項目をメソッドが取得した場合、戻り値は S_OK です。それ以外の場合は S_FALSE です。

解説(Remarks)

このメソッドが正常に返された後、呼び出し元は配列内の各要素について Release(CONNECTDATA の pUnk メンバを参照)を呼び出す責任があります。cConnections が 1 より大きい場合、呼び出し元は解放すべきポインタの数を取得するために、lpcFetched に渡す NULL 以外のポインタも渡す必要があります。

E_NOTIMPL は戻り値として許可されていません。エラー値が返された場合、終了時に配列内のエントリはいずれも有効ではないため、解放は不要です。

vtbl 4 HRESULT Skip(DWORD cConnections)

列挙シーケンス内の指定された数の項目をスキップします。(IEnumConnections.Skip)

cConnectionsDWORDinスキップする項目の数。

戻り値

要求された数の項目をメソッドがスキップした場合、戻り値は S_OK です。それ以外の場合は S_FALSE です。

vtbl 5 HRESULT Reset()

列挙シーケンスを先頭にリセットします。(IEnumConnections.Reset)

戻り値

戻り値は S_OK です。

解説(Remarks)

リセット操作の完了後に、同じオブジェクトの集合が列挙される保証はありません。静的なコレクションは先頭にリセットされますが、ディレクトリ内のファイルなど一部のコレクションでは、この条件を保証するのはコストが高すぎる場合があります。

vtbl 6 HRESULT Clone(IEnumConnections** ppEnum)

現在の列挙子と同じ列挙状態を持つ新しい列挙子を作成します。(IEnumConnections.Clone)

ppEnumIEnumConnections**out複製された列挙子オブジェクトへのポインタ。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、および S_OK を返すことができます。

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