ISyncMgrHandlerInfo::GetComment メソッド (syncmgr.h)

ハンドラーに関する解説を含む文字列を取得します。

構文

HRESULT GetComment(
  [out] LPWSTR *ppszComment
);

パラメーター

[out] ppszComment

種類: LPWSTR*

このメソッドが戻るとき、 にはコメント文字列を含むバッファーへのポインターが含まれます。 この文字列は、終端の null 文字を含む最大長MAX_SYNCMGR_NAMEです。

戻り値

種類: HRESULT

成功した場合はS_OKを返し、それ以外の場合はエラー値を返します。 メソッドが失敗した場合、 ppszComment には空の文字列が含まれます。

解説

この文字列は、"32 連絡先" や "13 曲" など、パートナーシップの内容の概要を表示するハンドラーによって提供される場合があります。 文字列は、終端の null 文字を含むMAX_SYNCMGR_NAMEの最大長を持つことができます。

同期が実行されていない場合、コメント値はフォルダー UI の System.Sync.Comments (PKEY_Sync_Comments) プロパティとして表示されます。

Sync Center は 、UpdateHandler メソッドが呼び出されるたびにこのメソッドを呼び出します。

ハンドラーは、CoTaskMemAlloc を介して ppszComment が指す文字列バッファーを割り当てる役割を担います。 Sync Center は 、CoTaskMemFree を介して文字列バッファーの割り当てを解除します。

要件