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

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

  • Статья

Включает или отключает элемент синхронизации.

Синтаксис

HRESULT Enable(
  [in] BOOL fEnable
);

Параметры

[in] fEnable

Тип: BOOL

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

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

Тип: HRESULT

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

Комментарии

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

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

Примеры

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

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

Требования

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