Método ISyncMgrHandlerInfo::IsActive (syncmgr.h)
Obtiene un valor que indica si el controlador se puede sincronizar.
Sintaxis
HRESULT IsActive();
Valor devuelto
Tipo: HRESULT
Devuelve S_OK si el controlador está activo; 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, Sync Center establece el estado del controlador en el último valor conocido. Si el último valor conocido del controlador en esa situación estaba inactivo, el Centro de sincronización deshabilita la tarea de instalación . Si el último valor conocido del controlador estaba activo, la tarea Eliminar no está deshabilitada.
Si la marca SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE o SYNCMGR_HCM_QUERY_BEFORE_DEACTIVE se establece en la máscara devuelta desde GetCapabilities, el controlador debe administrar su propio estado de activación y, por tanto, debe devolver S_OK o S_FALSE. Cualquier otro valor devuelto se considerará un error.
Comentarios
Si un controlador no está activo, aparece en la carpeta Configuración de sincronización. Los controladores de esa carpeta no se pueden sincronizar. Para mover un controlador a la carpeta Centro de sincronización, el usuario selecciona la tarea De instalación en el menú contextual del controlador o en el módulo de comandos.
Si un controlador está activo, aparece en la carpeta principal del Centro de sincronización. El usuario puede sincronizar un controlador que está activo o a través de la interfaz ISyncMgrControl . Para mover un controlador a la carpeta Configuración de sincronización, el usuario selecciona la tarea Eliminar en el menú contextual del controlador o en el módulo de comandos.
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 activo.
STDMETHODIMP CMyDeviceHandler::IsActive()
{
// Return a previously-calculated value.
return (_fIsActive ? 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 |