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

  • Статья

Запрашивает включение или отключение активного обработчика. Включенный обработчик можно синхронизировать, а отключенный обработчик — нет.

Синтаксис

HRESULT Enable(
  [in] BOOL fEnable
);

Параметры

[in] fEnable

Тип: BOOL

Значение TRUE для включения; Значение FALSE для отключения.

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

Тип: HRESULT

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

Комментарии

Обработчик должен задать флаги SYNCMGR_HCM_CAN_ENABLE и SYNCMGR_HCM_CAN_DISABLE , чтобы записи Включить и Отключить отображались в контекстном меню обработчика, когда обработчик отображается в папке Центра синхронизации. Включение обработчика означает, что его можно синхронизировать; Отключение обработчика означает, что он не может.

Центр синхронизации вызывает этот метод в следующих двух экземплярах.

  • Когда пользователь выбирает обработчик в папке Центра синхронизации и запускает задачу Включить . Если обработчик поддерживает объект SYNCMGR_OBJECTID_QueryBeforeEnable , этот метод вызывается только при успешном выполнении операции пользовательского интерфейса.
  • Когда пользователь выбирает обработчик в папке Центра синхронизации и запускает задачу "Отключить ". Если обработчик поддерживает объект SYNCMGR_OBJECTID_QueryBeforeDisable , этот метод вызывается только при успешном выполнении операции пользовательского интерфейса.
Если обработчику не нужно выполнять какие-либо действия при активации, он может возвращать либо S_OK, либо E_NOTIMPL, как показано в примере ниже.

Примеры

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

STDMETHODIMP CMyDeviceHandler::Enable(__in BOOL fEnable)
{
    return E_NOTIMPL;
}

Требования

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

См. также раздел

ISyncMgrHandler

ISyncMgrHandler::GetObject

IsEnabled