ISyncMgrHandler::GetName 方法 (syncmgr.h)

获取处理程序的显示名称。

语法

HRESULT GetName(
  [out] LPWSTR *ppszName
);

参数

[out] ppszName

类型: LPWSTR*

此方法返回时,包含指向接收处理程序名称 的 null 终止缓冲区的指针。 名称可以是最大长度MAX_SYNCMGR_NAME,包括终止 null 字符。 如果名称超过该长度,则将其截断。

返回值

类型: HRESULT

如果此方法成功,则返回 S_OK。 否则,它将返回 HRESULT 错误代码。

注解

处理程序名称作为 Sync Center 文件夹中的 System.DisplayName (PKEY_DisplayName) 属性进行访问。

每当调用 UpdateHandler 或 UpdateHandlerCollection 时,同步中心都调用此方法。 如果 ISyncMgrHandler::GetName 失败或返回空字符串,则处理程序不会显示在同步中心文件夹中,同步中心不会尝试调用它。

处理程序负责使用 CoTaskMemAlloc 分配字符串缓冲区。 同步中心通过 CoTaskMemFree 解除分配缓冲区。

ISyncMgrHandler::GetName 将替换 GetHandlerInfo 用于检索处理程序名称。

要求

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