Поделиться через


Метод ISyncMgrSyncItemInfo::GetTypeLabel (syncmgr.h)

Возвращает метку для типа элемента. Обычно предоставляется модель устройства или эквивалентная строка удостоверения для конкретного элемента.

Синтаксис

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

Параметры

[out] ppszTypeLabel

Тип: LPWSTR*

При возврате этим методом содержит указатель на буфер, содержащий строку метки.

Возвращаемое значение

Тип: HRESULT

Возвращает S_OK в случае успешного выполнения или значение ошибки в противном случае. Если метод завершается ошибкой, ppszTypeLabel содержит пустую строку.

Комментарии

Значение метки отображается как свойство System.Sync.ItemTypeLabel (PKEY_Sync_ItemTypeLabel) в пользовательском интерфейсе папки. Центр синхронизации вызывает этот метод при каждом вызове метода UpdateHandler или UpdateItem .

Элемент отвечает за выделение строкового буфера, на который указывает ppszTypeLabel , через CoTaskMemAlloc. Центр синхронизации освобождает буфер строки через CoTaskMemFree.

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2008 [только классические приложения]
Целевая платформа Windows
Header syncmgr.h