ISyncMgrHandler::GetName メソッド (syncmgr.h)

ハンドラーの表示名を取得します。

構文

HRESULT GetName(
  [out] LPWSTR *ppszName
);

パラメーター

[out] ppszName

種類: LPWSTR*

このメソッドが戻るときに、 には、ハンドラー名を受け取る null で終わるバッファーへのポインターが含まれます。 名前には、終端の null 文字を含め、MAX_SYNCMGR_NAMEの最大長を指定できます。 名前がその長さを超えると、切り捨てられます。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

ハンドラー名は、Sync Center フォルダーの System.DisplayName (PKEY_DisplayName) プロパティとしてアクセスされます。

Sync Center は、UpdateHandler または UpdateHandlerCollection が呼び出されるたびに、このメソッドを呼び出します。 ISyncMgrHandler::GetName が失敗するか、空の文字列を返した場合、ハンドラーは同期センター フォルダーに表示されず、同期センターでは呼び出しが試行されません。

CoTaskMemAlloc を使用して文字列バッファーを割り当てるのはハンドラーの役割です。 同期センターは 、CoTaskMemFree を介してバッファーの割り当てを解除します。

ISyncMgrHandler::GetName は、GetHandlerInfo を使用してハンドラー名を取得する代わりに使用します。

要件