ホーム › System.Contacts › IContactPropertyCollection
IContactPropertyCollection
COM公式ドキュメント
使用しないでください。ラベルまたはプロパティセットに基づいて連絡先データをフィルターするために使用されます。IContactProperties オブジェクトで公開される連絡先プロパティを列挙します。各プロパティについて、名前、型、バージョン、更新日を取得できます。
解説(Remarks)
Note このインターフェースでプロパティを列挙している最中に IContactProperties プロパティオブジェクトを変更すると、
動作は未定義になります。
メソッド 7
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
vtbl 3 HRESULT Reset()
プロパティの列挙をリセットします。
戻り値
解説(Remarks)
Note コレクションは(要素が存在する場合は)最初の要素より前の位置にリセットされます。
そのため、データのクエリを開始するには IContactPropertyCollection::Next を呼び出す必要があります。
vtbl 4 HRESULT Next()
次のプロパティに移動します。
戻り値
解説(Remarks)
Note S_FALSE が返された後、インターフェースのクエリメソッドをさらに呼び出すと失敗します。
vtbl 5 HRESULT GetPropertyName(LPWSTR pszPropertyName, DWORD cchPropertyName, DWORD* pdwcchPropertyNameRequired)
列挙中の現在のプロパティの名前を取得します。
| pszPropertyName | LPWSTR | inout | 成功した場合、IContactProperties でクエリを行うために使用する名前が格納されます。 例: toplevel、または toplevel/secondlevel[4]/thirdlevel。 |
| cchPropertyName | DWORD | in | 呼び出し元が割り当てたバッファーのサイズを文字数で指定します。 |
| pdwcchPropertyNameRequired | DWORD* | inout | 失敗した場合、pszPropertyName に必要なサイズが格納されます。 |
戻り値
型: HRESULT
次のいずれかの値を返します。
| 戻り値 | 説明 |
|---|---|
| クエリに成功しました。 | |
| pszPropertyName が値を格納するのに十分な大きさではありませんでした。 必要なバッファーサイズは *pdwcchPropertyNameRequired に格納されます。 |
列挙中の現在のプロパティの型を取得します。
| pdwType | DWORD* | inout | プロパティの型を指定します。
|
戻り値
列挙中の現在のプロパティのバージョン番号を取得します。
| pdwVersion | DWORD* | inout | プロパティのバージョンを指定します。 |
戻り値
列挙中の現在のプロパティの最終更新日を取得します。更新されていない場合は、連絡先の作成日が返されます。
| pftModificationDate | FILETIME* | inout | 最終更新日を UTC の FILETIME として指定します。 |
戻り値
vtbl 9 HRESULT GetPropertyArrayElementID(LPWSTR pszArrayElementID, DWORD cchArrayElementID, DWORD* pdwcchArrayElementIDRequired)
プロパティ配列内の指定した要素の一意な ID を取得します。
| pszArrayElementID | LPWSTR | inout | 成功した場合、要素の一意な ID が格納されます。 |
| cchArrayElementID | DWORD | in | 呼び出し元が割り当てたバッファーのサイズを文字数で指定します。 |
| pdwcchArrayElementIDRequired | DWORD* | inout | 失敗した場合、pszArrayElementID に必要なサイズが格納されます。 |
戻り値
型: HRESULT
次のいずれかの値を返します。
| 戻り値 | 説明 |
|---|---|
| クエリに成功しました。 | |
| 配列ノードに一意な配列要素 ID がありません。 | |
| pszArrayElementID が値を格納するのに十分な大きさではありませんでした。 必要なバッファーサイズは *pdwcchArrayElementIDRequired に格納されます。 |
解説(Remarks)
Note 現在のプロパティに対して IContactPropertyCollection::GetPropertyType
が CGD_ARRAY_NODE を返す場合にのみ有効です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_IContactPropertyCollection "{FFD3ADF8-FA64-4328-B1B6-2E0DB509CB3C}" #usecom global IContactPropertyCollection IID_IContactPropertyCollection "{}" #comfunc global IContactPropertyCollection_Reset 3 #comfunc global IContactPropertyCollection_Next 4 #comfunc global IContactPropertyCollection_GetPropertyName 5 var,int,var #comfunc global IContactPropertyCollection_GetPropertyType 6 var #comfunc global IContactPropertyCollection_GetPropertyVersion 7 var #comfunc global IContactPropertyCollection_GetPropertyModificationDate 8 var #comfunc global IContactPropertyCollection_GetPropertyArrayElementID 9 var,int,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IContactPropertyCollection "{FFD3ADF8-FA64-4328-B1B6-2E0DB509CB3C}" #usecom global IContactPropertyCollection IID_IContactPropertyCollection "{}" #comfunc global IContactPropertyCollection_Reset 3 #comfunc global IContactPropertyCollection_Next 4 #comfunc global IContactPropertyCollection_GetPropertyName 5 sptr,int,sptr #comfunc global IContactPropertyCollection_GetPropertyType 6 sptr #comfunc global IContactPropertyCollection_GetPropertyVersion 7 sptr #comfunc global IContactPropertyCollection_GetPropertyModificationDate 8 sptr #comfunc global IContactPropertyCollection_GetPropertyArrayElementID 9 sptr,int,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。