Edit

Share via

ISyncMgrSyncItemInfo::GetTypeLabel method (syncmgr.h)

  • Article

Gets a label for the item type. This typically provides the model of the device or an equivalent item-specific identity string.

Syntax

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

Parameters

[out] ppszTypeLabel

Type: LPWSTR*

When this method returns, contains a pointer to a buffer containing the label string.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise. If the method fails, ppszTypeLabel contains an empty string.

Remarks

The label value is displayed as the System.Sync.ItemTypeLabel (PKEY_Sync_ItemTypeLabel) property in the folder UI. Sync Center calls this method whenever the UpdateHandler or UpdateItem method is called.

The item is responsible for allocating the string buffer pointed to by ppszTypeLabel through CoTaskMemAlloc. Sync Center deallocates the string buffer through CoTaskMemFree.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header syncmgr.h