Compartir a través de

Método ISyncMgrHandler::Enable (syncmgr.h)

  • Artículo

Solicita que se habilite o deshabilite un controlador activo . Se puede sincronizar un controlador habilitado y no se puede deshabilitar un controlador.

Sintaxis

HRESULT Enable(
  [in] BOOL fEnable
);

Parámetros

[in] fEnable

Tipo: BOOL

TRUE para habilitar; FALSE para deshabilitar.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Un controlador debe establecer las marcas SYNCMGR_HCM_CAN_ENABLE y SYNCMGR_HCM_CAN_DISABLE para que aparezcan las entradas Habilitar y Deshabilitar en el menú contextual del controlador cuando el controlador se muestra en la carpeta Centro de sincronización. Elegir habilitar un controlador significa que se puede sincronizar; elegir deshabilitar un controlador significa que no puede.

El Centro de sincronización llama a este método en las dos instancias siguientes.

  • Cuando el usuario selecciona el controlador en la carpeta Centro de sincronización e inicia su tarea Habilitar . Si el controlador admite el objeto SYNCMGR_OBJECTID_QueryBeforeEnable , solo se llama a este método si la operación de la interfaz de usuario se realizó correctamente.
  • Cuando el usuario selecciona el controlador en la carpeta Centro de sincronización e inicia su tarea Deshabilitar . Si el controlador admite el objeto SYNCMGR_OBJECTID_QueryBeforeDisable , solo se llama a este método si la operación de interfaz de usuario se realizó correctamente.
Si el controlador no necesita realizar ninguna acción cuando se activa, puede devolver S_OK o E_NOTIMPL como se muestra en el ejemplo siguiente.

Ejemplos

En el ejemplo siguiente se muestra una implementación sencilla de este método.

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

Requisitos

   
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

Consulte también

ISyncMgrHandler

ISyncMgrHandler::GetObject

IsEnabled