Méthode ISyncMgrControl ::EnableItem (syncmgr.h)

Article
03/06/2024

Active ou désactive un élément de synchronisation géré par un gestionnaire spécifié.

Syntaxe

HRESULT EnableItem(
  [in] BOOL                  fEnable,
  [in] LPCWSTR               pszHandlerID,
  [in] LPCWSTR               pszItemID,
  [in] HWND                  hwndOwner,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Paramètres

[in] fEnable

Type : BOOL

TRUE pour activer ; FALSE à désactiver.

[in] pszHandlerID

Type : LPCWSTR

Pointeur vers une mémoire tampon contenant l’ID unique du gestionnaire. Cette chaîne est de longueur maximale MAX_SYNCMGR_ID y compris le caractère null de fin.

[in] pszItemID

Type : LPCWSTR

Pointeur vers une mémoire tampon contenant l’ID unique de l’élément. Cette chaîne est de longueur maximale MAX_SYNCMGR_ID y compris le caractère null de fin.

[in] hwndOwner

Type : HWND

Handle d’une fenêtre qui peut être utilisé par l’élément pour afficher toute interface utilisateur nécessaire. Cette valeur peut être NULL.

[in] nControlFlags

Type : SYNCMGR_CONTROL_FLAGS

Valeur de l’énumération SYNCMGR_CONTROL_FLAGS spécifiant si l’activation ou la désactivation de l’élément doit être effectuée de manière synchrone ou asynchrone.

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 élément activé est un élément qui peut être synchronisé.

Si l’élément spécifié retourne SYNCMGR_ICM_QUERY_BEFORE_ENABLE ou SYNCMGR_ICM_QUERY_BEFORE_DISABLE dans le masque retourné par la méthode GetCapabilities , une boîte de dialogue de confirmation s’affiche à l’utilisateur avant que l’élément soit activé ou désactivé. Si aucune interface utilisateur de requête n’est demandée ou une fois que l’utilisateur confirme l’opération, la méthode Enable de l’élément est appelée.

Si SYNCMGR_CF_WAIT est défini dans le paramètre nControlFlags , EnableItem ne retourne pas tant que le Centre de synchronisation n’a pas traité cette notification.

Exemples

L’exemple suivant montre l’utilisation d’ISyncMgrControl ::EnableHandler par la procédure d’un gestionnaire.

void MiscProc(...)
{
    ...

    // Get the Sync Center control object.
    ISyncMgrControl *pControl = NULL;
    
    hr = CoCreateInstance(CLSID_SyncMgrControl, 
                          CLSCTX_SERVER, 
                          IID_PPV_ARGS(&pControl));
    if (SUCCEEDED(hr))
    {
        // Tell Sync Center to disable the item.
        hr = pControl->EnableItem(FALSE, 
                                  s_szMySyncHandlerID,
                                  s_szMySyncHandlerMusicContentID, 
                                  hwnd,
                                  SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}

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