Win32 API 日本語リファレンス
ホーム › UI.Shell › ISyncMgrSyncItemContainer

ISyncMgrSyncItemContainer

COM
📘 Microsoft Learn (日本語) · English
IID90701133-be32-4129-a65c-99e616cafff4継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ハンドラーに対して、そのハンドラーが保持する項目に関する情報を提供するメソッドを公開します。

解説(Remarks)

Sync Center は、ISyncMgrHandler インターフェイスに対して QueryInterface を呼び出して、ISyncMgrSyncItemContainer インターフェイスへのポインターを取得します。

メソッド 3

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

vtbl 3 HRESULT GetSyncItem(LPWSTR pszItemID, ISyncMgrSyncItem** ppItem)

指定された同期項目を取得します。

pszItemIDLPWSTRin目的の項目を表す項目 ID を格納したバッファーへのポインター。ID は、終端の null 文字を含めて最大長 MAX_SYNCMGR_ID です。
ppItemISyncMgrSyncItem**outこのメソッドが返ると、同期項目を表す ISyncMgrSyncItem インスタンスへのポインターのアドレスが格納されます。

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合はエラー値を返します。ハンドラーが ppszItemID で指定された ID を認識しない場合は E_INVALIDARG を返します。

vtbl 4 HRESULT GetSyncItemEnumerator(IEnumSyncMgrSyncItems** ppenum)

ハンドラーの同期項目を列挙するインターフェイスを取得します。

ppenumIEnumSyncMgrSyncItems**outこのメソッドが返ると、IEnumSyncMgrSyncItems インスタンスへのポインターのアドレスが格納されます。IEnumSyncMgrSyncItems を使用すると、集合内の各同期項目のインターフェイスを取得できます。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは、以前の EnumSyncMgrItems メソッドに代わるものです。以前のメソッドは、各同期項目に対して SYNCMGRITEM 構造体を返す列挙子インターフェイスを返していました。この構造体が以前提供していたデータを取得するために、Sync Center は各項目の ISyncMgrSyncItem インターフェイスに対して QueryInterface を呼び出し、対応する ISyncMgrSyncItemInfo インターフェイスを要求します。

列挙される項目の数は、ISyncMgrSyncItemContainer::GetSyncItemCount メソッドで取得できます。

例

次の例は、このメソッドの実装を示しています。

STDMETHODIMP CMyDeviceHandler::GetSyncItemEnumerator(
    __out IEnumSyncMgrSyncItems **ppenum)
{
    *ppenum = NULL;

    // Load the items using a private class method.
    HRESULT hr = _LoadItems();

    if (SUCCEEDED(hr))
    {
        hr = CEnumSyncMgrSyncItems_CreateInstance(this,
                                                  IID_PPV_ARGS(ppenum));
    }

    return hr;
}
vtbl 5 HRESULT GetSyncItemCount(DWORD* pcItems)

コンテナー内の同期項目の数を取得します。

pcItemsDWORD*outこのメソッドが返ると、コンテナー内の項目数へのポインターが格納されます。これは IEnumSyncMgrSyncItems によって列挙される項目の数です。

戻り値

型: HRESULT

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

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