ISyncMgrHandlerInfo::GetTypeLabel メソッド (syncmgr.h)

ハンドラー型のラベルを取得します。 これは通常、デバイスのモデルまたは同等のハンドラー固有の ID 文字列を提供します。

構文

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

パラメーター

[out] ppszTypeLabel

種類: LPWSTR*

このメソッドが戻るとき、 には、ラベル文字列を含むバッファーへのポインターが含まれます。

戻り値

種類: HRESULT

成功した場合はS_OKを返し、それ以外の場合はエラー値を返します。 メソッドが失敗した場合、 ppszTypeLabel には空の文字列が含まれます。

注釈

ラベルの値は、フォルダー UI の System.Sync.HandlerTypeLabel (PKEY_Sync_HandlerTypeLabel) プロパティとして表示されます。 Sync Center は 、UpdateHandler メソッドが呼び出されるたびにこのメソッドを呼び出します。

ハンドラーは、CoTaskMemAlloc を介して ppszTypeLabel によって指される文字列バッファーを割り当てる役割を担います。 Sync Center は 、CoTaskMemFree を介して文字列バッファーの割り当てを解除します。

例

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

STDMETHODIMP CMyDeviceHandler::GetTypeLabel(__out LPWSTR *ppszTypeLabel)
{
    LPWSTR pszTypeLabel = NULL;

    HRESULT hr = LoadStringAlloc(g_hmodThisDll, 
                                 IDS_HANDLER_TYPE_LABEL,
                                 &pszTypeLabel);
    if (SUCCEEDED(hr))
    {
        // Duplicate for the caller.
        hr = SHCoAllocString(pszTypeLabel, ppszTypeLabel);
        LocalFree(pszTypeLabel);
    }

    return hr;
}

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	syncmgr.h