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

規格需求