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

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

Синтаксис

HRESULT IsActive();

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

Тип: HRESULT

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

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

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

Комментарии

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

Если обработчик активен, он отображается в папке центра синхронизации main. Активный обработчик может быть синхронизирован пользователем или через интерфейс ISyncMgrControl . Чтобы переместить обработчик в папку Настройка синхронизации, пользователь выбирает задачу Удалить в контекстном меню обработчика или в командном модуле.

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

Примеры

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

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

Требования

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

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

Активировать

ISyncMgrHandlerInfo