ISyncMgrSyncItemInfo::GetTypeLabel メソッド (syncmgr.h)

項目の種類のラベルを取得します。 これは通常、デバイスのモデルまたは同等の項目固有の ID 文字列を提供します。

構文

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

パラメーター

[out] ppszTypeLabel

種類: LPWSTR*

このメソッドが戻るとき、 には、ラベル文字列を含むバッファーへのポインターが含まれます。

戻り値

種類: HRESULT

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

注釈

ラベルの値は、フォルダー UI の System.Sync.ItemTypeLabel (PKEY_Sync_ItemTypeLabel) プロパティとして表示されます。 Sync Center は、 UpdateHandler メソッドまたは UpdateItem メソッドが呼び出されるたびに、このメソッドを呼び出します。

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

要件