ISyncMgrHandlerInfo ::IsActive, méthode (syncmgr.h)
Obtient une valeur qui indique si le gestionnaire peut être synchronisé.
Syntaxe
HRESULT IsActive();
Valeur de retour
Type : HRESULT
Retourne S_OK si le gestionnaire est actif ; sinon, S_FALSE.
Si le gestionnaire souhaite que le Centre de synchronisation conserve l’état actuel, il peut retourner E_NOTIMPL. Si une autre valeur est retournée, le Centre de synchronisation définit l’état du gestionnaire sur la dernière valeur connue. Si la dernière valeur connue du gestionnaire dans cette situation était inactive, le Centre de synchronisation désactive la tâche d’installation . Si la dernière valeur connue du gestionnaire était active, la tâche Supprimer n’est pas désactivée.
Si l’indicateur SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE ou SYNCMGR_HCM_QUERY_BEFORE_DEACTIVE est défini dans le masque retourné par GetCapabilities, le gestionnaire doit gérer son propre état d’activation et doit donc retourner S_OK ou S_FALSE. Toute autre valeur de retour sera considérée comme une erreur.
Remarques
Si un gestionnaire n’est pas actif, il apparaît dans le dossier Installation de synchronisation. Les gestionnaires de ce dossier ne peuvent pas être synchronisés. Pour déplacer un gestionnaire vers le dossier centre de synchronisation, l’utilisateur sélectionne la tâche d’installation dans le menu contextuel du gestionnaire ou à partir du module de commandes.
Si un gestionnaire est actif, il apparaît dans le dossier centre de synchronisation main. Un gestionnaire actif peut être synchronisé par l’utilisateur ou via l’interface ISyncMgrControl . Pour déplacer un gestionnaire vers le dossier Installation de synchronisation, l’utilisateur sélectionne la tâche Supprimer dans le menu contextuel du gestionnaire ou dans le module de commandes.
Le Centre de synchronisation appelle cette méthode chaque fois que la méthode UpdateHandler est appelée.
Exemples
L’exemple suivant montre une implémentation de cette méthode qui appelle une fonction de classe privée pour récupérer l’état actif.
STDMETHODIMP CMyDeviceHandler::IsActive()
{
// Return a previously-calculated value.
return (_fIsActive ? S_OK : S_FALSE);
}
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows Vista [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2008 [applications de bureau uniquement] |
| Plateforme cible | Windows |
| En-tête | syncmgr.h |