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

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

  • Статья

Возвращает значение, указывающее, включен ли обработчик.

Синтаксис

HRESULT IsEnabled();

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

Тип: HRESULT

Возвращает S_OK, если обработчик включен; в противном случае S_FALSE.

Если обработчик хочет, чтобы центр синхронизации поддерживал текущее состояние, он может вернуть E_NOTIMPL. Если возвращается какое-либо другое значение, центр синхронизации устанавливает последнее известное значение для обработчика и включает или отключает связанные задачи соответствующим образом.

Если флаг SYNCMGR_HCM_QUERY_BEFORE_ENABLE или SYNCMGR_HCM_QUERY_BEFORE_DISABLE установлен в маске, возвращаемой из GetCapabilities, обработчик должен управлять собственным включенным состоянием и поэтому должен возвращать либо S_OK, либо S_FALSE. Любое другое возвращаемое значение будет считаться ошибкой.

Комментарии

Если обработчик отключен, ни его элементы не будут синхронизированы центром синхронизации. Кроме того, многие из возможных действий, доступных обработчику, например Синхронизация, удаляются или отключаются в пользовательском интерфейсе папки Центра синхронизации.

Это значение доступно в пользовательском интерфейсе папки как свойство System.Sync.Enabled (PKEY_Sync_Enabled).

Центр синхронизации вызывает этот метод при каждом вызове метода UpdateHandler .

Примеры

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

STDMETHODIMP CMyDeviceHandler::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? S_OK : S_FALSE);
}

Требования

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

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

Разрешить

ISyncMgrHandlerInfo