(syncmgr.h) ISyncMgrHandlerInfo：：GetComment 方法

取得字串，其中包含處理常式的相關建議。

語法

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解除配置字串緩衝區。