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

Article
03/02/2024

Demande au Centre de synchronisation d’énumérer à nouveau les éléments gérés par un gestionnaire ou l’informe que les propriétés du gestionnaire ont changé.

Syntaxe

HRESULT UpdateHandler(
  [in] LPCWSTR               pszHandlerID,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Paramètres

[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] nControlFlags

Type : SYNCMGR_CONTROL_FLAGS

Valeur de l’énumération SYNCMGR_CONTROL_FLAGS spécifiant si la mise à jour 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

Si SYNCMGR_CF_WAIT est défini dans le paramètre nControlFlags , UpdateHandler ne retourne pas tant que le Centre de synchronisation n’a pas chargé le gestionnaire spécifié et rechargé toutes les informations relatives au gestionnaire et à l’élément. Si le gestionnaire est fourni par une collection de gestionnaires, la collection de gestionnaires est également chargée pour recharger le gestionnaire.

Exemples

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

void CMyDeviceHandler::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 that properties on the handler have changed.
        hr = pControl->UpdateHandler(s_szMySyncHandlerID, 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