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