Méthode ISyncMgrHandlerInfo ::IsEnabled (syncmgr.h)

Obtient une valeur qui indique si le gestionnaire est activé.

Syntaxe

HRESULT IsEnabled();

Valeur de retour

Type : HRESULT

Retourne S_OK si le gestionnaire est activé ; 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 activé du gestionnaire sur la dernière valeur connue et active ou désactive les tâches associées comme il convient.

Si l’indicateur SYNCMGR_HCM_QUERY_BEFORE_ENABLE ou SYNCMGR_HCM_QUERY_BEFORE_DISABLE est défini dans le masque retourné par GetCapabilities, le gestionnaire doit gérer son propre état activé 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 est désactivé, ni lui ni aucun de ses éléments ne seront synchronisés par le Centre de synchronisation. En outre, un grand nombre des actions possibles disponibles pour un gestionnaire, telles que Synchroniser, sont supprimées ou désactivées dans l’interface utilisateur du dossier centre de synchronisation.

Cette valeur est disponible dans l’interface utilisateur du dossier en tant que propriété System.Sync.Enabled (PKEY_Sync_Enabled).

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 activé.

STDMETHODIMP CMyDeviceHandler::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? S_OK : S_FALSE);
}

Configuration requise

Voir aussi

Activer

ISyncMgrHandlerInfo