ISyncProviderConfigUI
COM公式ドキュメント
同期プロバイダーを構築して登録するために使用される構成 UI 情報を表します。
解説(Remarks)
同期プロバイダーを作成する前に追加の情報やプロパティの設定が必要な場合、同期プロバイダーの作成者は、その同期プロバイダー用に ISyncProviderConfigUI(ビルダー)を実装する必要があります。たとえば、同期プロバイダーによっては、データを同期する前にユーザーが資格情報を入力する必要がある場合があります。
登録された同期プロバイダーが Microsoft Sync Framework のプロバイダーである場合、Init メソッドは Sync Framework の同期セッションによって呼び出されます。Windows 向けに作成できる同期プロバイダーの種類の詳細については、Options for Building a Synchronization Provider を参照してください。
メソッド 4
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
同期プロバイダーの構成 UI を初期化します。
| pguidInstanceId | GUID* | in | 構成 UI のインスタンス ID。 |
| pguidContentType | GUID* | in | この構成 UI が作成する同期プロバイダーに関連付けられるコンテンツ タイプを表す GUID。 |
| pConfigurationProperties | IPropertyStore* | inoptional | 構成 UI が同期プロバイダーを登録する際に指定する必要があるプロパティ。これらのプロパティは、 構成 UI オブジェクトを適切に初期化するためにも使用されます。 |
戻り値
返される可能性のあるコードには、次の表に示す値が含まれます(ただし、これらに限定されません)。
| リターン コード | 説明 |
|---|---|
| メソッドは成功しました。 |
解説(Remarks)
このメソッドは、いずれかの登録インターフェイスから構成 UI のインスタンスが要求されたときに、オブジェクトが返される前に登録コードによって呼び出されます。
読み取りおよび書き込みのために構成 UI のプロパティを取得します。
| ppConfigUIProperties | IPropertyStore** | out | 読み取りおよび書き込み用の構成 UI プロパティを格納する IPropertyStore オブジェクトを返します。ISyncProviderInfo インターフェイスと ISyncProviderConfigUIInfo インターフェイスは、いずれも IPropertyStore を継承しています。 |
戻り値
返される可能性のあるコードには、次の表に示す値が含まれます(ただし、これらに限定されません)。
| リターン コード | 説明 |
|---|---|
| メソッドは成功しました。 |
新しい同期プロバイダーを作成して登録します。
| hwndParent | HWND | inoptional | 同期プロバイダーを作成する前に表示する必要がある構成 UI の親となる HWND。 HWND を NULL にできるのは、SyncProviderConfigUIConfiguration 構造体の dwCapabilities メンバーが UI をサポートしないように設定されている場合のみです。 |
| pUnkContext | IUnknown* | inoptional | 同期プロバイダーの生成に必要な追加情報を格納したインターフェイスへのポインター。追加情報が不要な場合、このポインターは NULL になります。 |
| ppProviderInfo | ISyncProviderInfo** | out | 新しく作成および登録された同期プロバイダーに関する情報を格納する ISyncProviderInfo オブジェクト。 |
戻り値
返される可能性のあるコードには、次の表に示す値が含まれます(ただし、これらに限定されません)。
| リターン コード | 説明 |
|---|---|
| メソッドは成功しました。 | |
| ポインターが無効です。 | |
| 同期プロバイダーを作成して登録するための十分なメモリがありませんでした。 |
この ISyncProviderConfigUI によって構成される同期プロバイダーの ISyncProviderInfo を更新します。
| hwndParent | HWND | inoptional | 同期プロバイダーを作成する前に表示する必要がある構成 UI の親となる HWND。 HWND を NULL にできるのは、SyncProviderConfigUIConfiguration 構造体の dwCapabilities メンバーが UI をサポートしないように設定されている場合のみです。 |
| pUnkContext | IUnknown* | inoptional | 同期プロバイダーの生成に必要な追加情報を格納したインターフェイスへのポインター。追加情報が不要な場合、このポインターは NULL になります。 |
| pProviderInfo | ISyncProviderInfo* | inoptional | 変更対象の同期プロバイダーに関する情報を提供する ISyncProviderInfo。 |
戻り値
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ISyncProviderConfigUI "{7B0705F6-CBCD-4071-AB05-3BDC364D4A0C}" #usecom global ISyncProviderConfigUI IID_ISyncProviderConfigUI "{}" #comfunc global ISyncProviderConfigUI_Init 3 var,var,sptr #comfunc global ISyncProviderConfigUI_GetRegisteredProperties 4 sptr #comfunc global ISyncProviderConfigUI_CreateAndRegisterNewSyncProvider 5 sptr,sptr,sptr #comfunc global ISyncProviderConfigUI_ModifySyncProvider 6 sptr,sptr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ISyncProviderConfigUI "{7B0705F6-CBCD-4071-AB05-3BDC364D4A0C}" #usecom global ISyncProviderConfigUI IID_ISyncProviderConfigUI "{}" #comfunc global ISyncProviderConfigUI_Init 3 sptr,sptr,sptr #comfunc global ISyncProviderConfigUI_GetRegisteredProperties 4 sptr #comfunc global ISyncProviderConfigUI_CreateAndRegisterNewSyncProvider 5 sptr,sptr,sptr #comfunc global ISyncProviderConfigUI_ModifySyncProvider 6 sptr,sptr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。