ISyncMgrHandlerInfo：：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 解除分配字符串缓冲区。