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

Статья
03/05/2024

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

Синтаксис

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

Параметры

[out] ppszTypeLabel

Тип: LPWSTR*

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

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

Тип: HRESULT

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

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

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

Примеры

В следующем примере показана реализация этого метода.

STDMETHODIMP CMyDeviceHandler::GetTypeLabel(__out LPWSTR *ppszTypeLabel)
{
    LPWSTR pszTypeLabel = NULL;

    HRESULT hr = LoadStringAlloc(g_hmodThisDll, 
                                 IDS_HANDLER_TYPE_LABEL,
                                 &pszTypeLabel);
    if (SUCCEEDED(hr))
    {
        // Duplicate for the caller.
        hr = SHCoAllocString(pszTypeLabel, ppszTypeLabel);
        LocalFree(pszTypeLabel);
    }

    return hr;
}

Требования

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

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