ホーム › System.Contacts › IContactCollection

IContactCollection

COM

📘 Microsoft Learn (日本語) · English

IIDb6afa338-d779-11d9-8bde-f66bad1e3f3a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

使用しないでください。IContactManager が把握している連絡先を列挙します。

解説(Remarks)

このインターフェイスは、列挙中の連絡先の削除をサポートしていません。列挙中に他の手段で連絡先を追加または削除すると、動作は未定義になります。列挙中に連絡先のプロパティを変更することは許可されています。

メソッド 3

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

vtbl 3 HRESULT Reset()

列挙子を論理的な先頭要素の前にリセットします。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

IContactCollection::Reset の直後に IContactCollection::GetCurrent を呼び出した場合の動作は未定義です。最初の連絡先を取得するには、連絡先が存在することを確認するために、まず IContactCollection::Next を呼び出してください。

vtbl 4 HRESULT Next()

次の連絡先へ移動します。

戻り値

型: HRESULT

次のいずれかの値を返します。

戻り値コード	説明
S_OK	移動に成功しました。
S_FALSE	移動できませんでした。コレクションの末尾に位置しています。

解説(Remarks)

S_FALSE が返された後は、GetCurrent の呼び出しは失敗します。

vtbl 5 HRESULT GetCurrent(IContact** ppContact)

列挙内の現在の連絡先を取得します。

ppContact

IContact**

out

成功した場合、現在の連絡先が格納されます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

リセット後、まず IContactCollection::Next を呼び出さずに IContactCollection::GetCurrent を呼び出すと失敗します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IContactCollection "{B6AFA338-D779-11D9-8BDE-F66BAD1E3F3A}"
#usecom global IContactCollection IID_IContactCollection "{}"
#comfunc global IContactCollection_Reset       3
#comfunc global IContactCollection_Next        4
#comfunc global IContactCollection_GetCurrent  5 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。