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

Создает значение, указывающее, включен ли элемент.

Синтаксис

HRESULT IsEnabled();

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

Тип: HRESULT

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

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

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

Комментарии

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

Элемент может реализовать состояние Disconnected , возвращая S_FALSE из IsEnabled и устанавливая флаг SYNCMR_IPM_PREVENT_ENABLE в реализации GetPolicies . При этом элемент отображается как отключенный и пользователь не может включить его вручную.

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

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

Примеры

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

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

Требования