ISyncMgrSyncItemInfo::GetComment 方法 (syncmgr.h)

获取一个字符串,其中包含有关该项的注释。

语法

HRESULT GetComment(
  [out] LPWSTR *ppszComment
);

参数

[out] ppszComment

类型: LPWSTR*

此方法返回时,包含指向包含注释字符串的缓冲区的指针。 此字符串的最大长度MAX_SYNCMGR_NAME包括终止 null 字符。

返回值

类型: HRESULT

如果成功,则返回 S_OK,否则返回错误值。 如果方法失败, ppszComment 将包含一个空字符串。

注解

此字符串可由项提供以显示其内容的摘要,例如“32 个联系人”或“13 首歌曲”。 字符串的最大长度可以是MAX_SYNCMGR_NAME包括终止 null 字符。

未执行同步时,注释值在文件夹 UI 中显示为 System.Sync.Comments (PKEY_Sync_Comments) 属性。

每当调用 UpdateHandler 方法时,同步中心将调用此方法。

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

要求

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