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

同期項目の UI 表示名を取得します。

構文

HRESULT GetName(
  [out] LPWSTR *ppszName
);

パラメーター

[out] ppszName

種類: LPWSTR*

このメソッドが戻るとき、 には、アイテムの表示名を含むバッファーへのポインターが含まれます。 この文字列は、終端の null 文字を含む最大長MAX_SYNCMGR_NAMEです。 これより長い文字列は切り詰められます。

戻り値

種類: HRESULT

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

注釈

GetName が失敗した場合、または空の文字列が ppszItemID で返された場合、同期項目はハンドラーのフォルダーに表示されず、同期センターは同期を試みません。

このメソッドによって取得された ID は、ハンドラーのフォルダー UI で System.DisplayName (PKEY_DisplayName) プロパティとして使用できます。

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

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

以前の Sync Manager 実装では、この情報は SYNCMGRHANDLERINFO 構造体を介して取得されました。

例

次の例は、このメソッドの実装を示しています。

STDMETHODIMP CMyDeviceSyncItem::GetName(__out LPWSTR *ppszName)
{
    *ppszName = NULL;
    HRESULT hr = SHCoAllocString(_pszItemName, ppszName);
    return hr;
}

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	syncmgr.h