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

  • Article

Lance la synchronisation des éléments spécifiés gérés par un gestionnaire particulier.

Syntaxe

HRESULT StartItemSync(
  [in] LPCWSTR                    pszHandlerID,
  [in] LPCWSTR                    *ppszItemIDs,
  [in] ULONG                      cItems,
  [in] HWND                       hwndOwner,
  [in] IUnknown                   *punk,
  [in] SYNCMGR_SYNC_CONTROL_FLAGS nSyncControlFlags,
  [in] ISyncMgrSyncResult         *pResult
);

Paramètres

[in] pszHandlerID

Type : LPCWSTR

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

[in] ppszItemIDs

Type : LPCWSTR*

Adresse d’un pointeur vers une mémoire tampon contenant un tableau d’ID des éléments à synchroniser. Chaque ID a une longueur maximale MAX_SYNCMGR_ID y compris le caractère null de fin. Ce tableau est passé à Synchroniser.

[in] cItems

Type : DWORD

Nombre d’ID dans ppszItemIDs.

[in] hwndOwner

Type : HWND

Handle de la fenêtre que l’élément peut utiliser pour afficher toute interface utilisateur nécessaire. Cette valeur peut être NULL.

[in] punk

Type : IUnknown*

Pointeur vers un IUnknown à passer à Synchroniser. Ce paramètre peut être NULL.

[in] nSyncControlFlags

Type : SYNCMGR_SYNC_CONTROL_FLAGS

Membre de l’énumération SYNCMGR_SYNC_CONTROL_FLAGS qui spécifie si un élément trouvé dans une synchronisation actuelle et une synchronisation en file d’attente doit être resynchronisé lorsque la synchronisation en file d’attente est effectuée.

[in] pResult

Type : ISyncMgrSyncResult*

Pointeur vers un instance d’ISyncMgrSyncResult, dont la méthode Result est appelée à la fin de la synchronisation, par réussite, échec ou annulation. La méthode Result est appelée avec l’état agrégé de la synchronisation du gestionnaire. Ce paramètre peut être NULL.

Valeur retournée

Type : HRESULT

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

Remarques

Cette méthode est analogue à UpdateItems.

Exemples

L’exemple suivant montre l’utilisation d’ISyncMgrControl ::StartItemSync 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))
    {
        // Synchronize one sync item for the sync handler.
        hr = pControl->StartItemSync(s_szMySyncHandlerID,
                                     s_szMySyncHandlerMusicContentID,
                                     1,
                                     _hwnd,
                                     NULL,
                                     NULL);
        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