ISyncMgrSyncItem：：GetName 方法 (syncmgr.h)

获取同步项的 UI 显示名称。

语法

HRESULT GetName(
  [out] LPWSTR *ppszName
);

参数

[out] ppszName

类型： LPWSTR*

此方法返回时，包含指向包含项显示名称的缓冲区的指针。 此字符串的最大长度MAX_SYNCMGR_NAME包括终止 null 字符。 超过最大长度的字符串会被截断。

返回值

类型： HRESULT

如果该方法成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。

注解

如果 GetName 失败或在 ppszItemID 中返回空字符串，则同步项目不会显示在处理程序的文件夹中，并且同步中心不会尝试同步它。

此方法检索的 ID 在处理程序的文件夹 UI 中作为 System.DisplayName (PKEY_DisplayName) 属性提供。

项负责通过 CoTaskMemAlloc 分配 ppszComment 指向的字符串缓冲区。 同步中心通过 CoTaskMemFree 解除分配字符串缓冲区。

每当调用 UpdateItem 方法时，同步中心将调用此方法。

在较旧的同步管理器实现中，此信息是通过 SYNCMGRHANDLERINFO 结构检索的。

示例

以下示例演示此方法的实现。

STDMETHODIMP CMyDeviceSyncItem::GetName(__out LPWSTR *ppszName)
{
    *ppszName = NULL;
    HRESULT hr = SHCoAllocString(_pszItemName, ppszName);
    return hr;
}

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 [仅限桌面应用]
目标平台	Windows
标头	syncmgr.h