共用方式為

ISyncMgrHandlerInfo：：GetTypeLabel 方法 (syncmgr.h)

  • 發行項

取得處理程式類型的標籤。 這通常會提供裝置的模型或對等的處理程式特定識別字串。

語法

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

參數

[out] ppszTypeLabel

類型： LPWSTR*

當這個方法傳回時，包含包含卷標字串之緩衝區的指標。

傳回值

類型： HRESULT

如果成功，則傳回S_OK，否則傳回錯誤值。 如果方法失敗， ppszTypeLabel 會包含空字串。

備註

標籤值會顯示為資料夾 UI 中的 System.Sync.HandlerTypeLabel (PKEY_Sync_HandlerTypeLabel) 屬性。 每當呼叫 UpdateHandler 方法時，同步中心就會呼叫此方法。

處理程式負責透過 CoTaskMemAlloc 配置 ppszTypeLabel 所指向的字串緩衝區。 同步中心會透過 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