Método ISyncMgrHandlerInfo::IsEnabled (syncmgr.h)
Obtiene un valor que indica si el controlador está habilitado.
Sintaxis
HRESULT IsEnabled();
Valor devuelto
Tipo: HRESULT
Devuelve S_OK si el controlador está habilitado; de lo contrario, S_FALSE.
Si el controlador 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 controlador en el último valor conocido y habilita o deshabilita las tareas asociadas según corresponda.
Si la marca SYNCMGR_HCM_QUERY_BEFORE_ENABLE o SYNCMGR_HCM_QUERY_BEFORE_DISABLE se establece 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 controlador está deshabilitado, el Centro de sincronización no sincronizará ni ninguno de sus elementos. Además, muchas de las posibles acciones disponibles para un controlador, como Sync, se quitan o deshabilitan en la interfaz de usuario de la carpeta del Centro de sincronización.
Este valor 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 CMyDeviceHandler::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 |