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

Метод ISyncMgrHandler::GetName (syncmgr.h)

  • Статья

Возвращает отображаемое имя обработчика.

Синтаксис

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Параметры

[out] ppszName

Тип: LPWSTR*

При возврате этим методом содержит указатель на буфер, завершающийся значением NULL, который получает имя обработчика. Имя может иметь максимальную длину MAX_SYNCMGR_NAME, включая завершающий символ NULL . Если имя превышает длину, оно усекается.

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

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Имя обработчика доступно как свойство System.DisplayName (PKEY_DisplayName) в папке Центра синхронизации.

Центр синхронизации вызывает этот метод при любом вызове Метода UpdateHandler или UpdateHandlerCollection . Если ISyncMgrHandler::GetName завершается сбоем или возвращает пустую строку, обработчик не отображается в папке Центра синхронизации и не будет пытаться вызвать его.

Обработчик отвечает за выделение буфера строк с помощью CoTaskMemAlloc. Центр синхронизации освобождает буфер через CoTaskMemFree.

ISyncMgrHandler::GetName заменяет использование GetHandlerInfo для получения имени обработчика.

Требования

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