Partager via


ISyncMgrHandler::Enable, méthode (syncmgr.h)

Demande qu’un gestionnaire actif soit activé ou désactivé. Un gestionnaire activé peut être synchronisé et un gestionnaire désactivé ne peut pas.

Syntaxe

HRESULT Enable(
  [in] BOOL fEnable
);

Paramètres

[in] fEnable

Type : BOOL

TRUE pour activer ; FALSE à désactiver.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Un gestionnaire doit définir les indicateurs SYNCMGR_HCM_CAN_ENABLE et SYNCMGR_HCM_CAN_DISABLE pour que les entrées Activer et Désactiver s’affichent dans le menu contextuel du gestionnaire lorsque le gestionnaire s’affiche dans le dossier Centre de synchronisation. Le choix d’activer un gestionnaire signifie qu’il peut être synchronisé ; Si vous choisissez de désactiver un gestionnaire, cela signifie qu’il ne peut pas le faire.

Le Centre de synchronisation appelle cette méthode dans les deux instances suivantes.

  • Lorsque l’utilisateur sélectionne le gestionnaire dans le dossier Centre de synchronisation et lance sa tâche Activer . Si le gestionnaire prend en charge l’objet SYNCMGR_OBJECTID_QueryBeforeEnable , cette méthode est appelée uniquement si l’opération d’interface utilisateur a réussi.
  • Lorsque l’utilisateur sélectionne le gestionnaire dans le dossier centre de synchronisation et lance sa tâche Désactiver . Si le gestionnaire prend en charge l’objet SYNCMGR_OBJECTID_QueryBeforeDisable , cette méthode est appelée uniquement si l’opération d’interface utilisateur a réussi.
Si le gestionnaire n’a pas besoin d’effectuer d’actions lorsqu’il est activé, il peut retourner S_OK ou E_NOTIMPL comme indiqué dans l’exemple ci-dessous.

Exemples

L’exemple suivant montre une implémentation simple de cette méthode.

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

Configuration requise

   
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

Voir aussi

ISyncMgrHandler

ISyncMgrHandler::GetObject

IsEnabled