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

Article
03/02/2024

Génère une valeur qui indique si l’élément est activé.

Syntaxe

HRESULT IsEnabled();

Valeur de retour

Type : HRESULT

Retourne S_OK si l’élément est activé ; sinon, S_FALSE.

Si l’élément 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é de l’élément sur la dernière valeur connue et active ou désactive les tâches associées le cas échéant.

Si les indicateurs SYNCMGR_ICM_QUERY_BEFORE_ENABLE ou SYNCMGR_ICM_QUERY_BEFORE_DISABLE sont définis 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 élément est désactivé, il n’est pas synchronisé par le Centre de synchronisation. En outre, un grand nombre des actions possibles disponibles pour un élément, comme La synchronisation, sont supprimées ou désactivées dans l’interface utilisateur.

Un élément peut implémenter un état déconnecté en retournant S_FALSE à partir d’IsEnabled et en définissant l’indicateur SYNCMR_IPM_PREVENT_ENABLE dans son implémentation GetPolicies . Cela montre l’élément comme désactivé et empêche l’utilisateur de l’activer manuellement.

La valeur enabled 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 CMyDeviceSyncItem::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? 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

Partager via