Compartir a través de

Método ISyncMgrSyncItemInfo::IsEnabled (syncmgr.h)

  • Artículo

Genera un valor que indica si el elemento está habilitado.

Sintaxis

HRESULT IsEnabled();

Valor devuelto

Tipo: HRESULT

Devuelve S_OK si el elemento está habilitado; de lo contrario, S_FALSE.

Si el elemento quiere que el Centro de sincronización mantenga el estado actual, puede devolver E_NOTIMPL. Si se devuelve cualquier otro valor, el Centro de sincronización establece el estado habilitado del elemento en el último valor conocido y habilita o deshabilita las tareas asociadas según corresponda.

Si las marcas de SYNCMGR_ICM_QUERY_BEFORE_ENABLE o SYNCMGR_ICM_QUERY_BEFORE_DISABLE se establecen en la máscara devuelta desde GetCapabilities, el controlador debe administrar su propio estado habilitado y, por lo tanto, debe devolver S_OK o S_FALSE. Cualquier otro valor devuelto se considerará un error.

Comentarios

Si un elemento está deshabilitado, el Centro de sincronización no lo sincroniza. Además, muchas de las posibles acciones disponibles para un elemento (como Sincronizar) se quitan o deshabilitan en la interfaz de usuario.

Un elemento puede implementar un estado Desconectado devolviendo S_FALSE de IsEnabled y estableciendo la marca de SYNCMR_IPM_PREVENT_ENABLE en su implementación de GetPolicies . Esto muestra el elemento como deshabilitado e impide que el usuario lo habilite manualmente.

El valor habilitado está disponible en la interfaz de usuario de la carpeta como la propiedad System.Sync.Enabled (PKEY_Sync_Enabled).

El Centro de sincronización llama a este método cada vez que se llama al método UpdateHandler .

Ejemplos

En el ejemplo siguiente se muestra una implementación de este método que llama a una función de clase privada para recuperar el estado habilitado.

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

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado syncmgr.h