ISyncMgrSyncItemContainer ::GetSyncItemEnumerator, méthode (syncmgr.h)

Article
03/02/2024

Obtient une interface qui énumère les éléments de synchronisation du gestionnaire.

Syntaxe

HRESULT GetSyncItemEnumerator(
  [out] IEnumSyncMgrSyncItems **ppenum
);

Paramètres

[out] ppenum

Type : IEnumSyncMgrSyncItems**

Lorsque cette méthode est retournée, contient l’adresse d’un pointeur vers un instance IEnumSyncMgrSyncItems. IEnumSyncMgrSyncItems peut être utilisé pour récupérer une interface pour chaque élément de synchronisation de l’ensemble.

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 remplace l’ancienne méthode EnumSyncMgrItems . L’ancienne méthode a renvoyé une interface d’énumérateur qui a renvoyé une structure SYNCMGRITEM pour chaque élément de synchronisation. Pour obtenir les données précédemment fournies par cette structure, le Centre de synchronisation appelle QueryInterface sur l’interface ISyncMgrSyncItem de chaque élément pour demander une interface ISyncMgrSyncItemInfo correspondante.

Le nombre d’éléments énumérés peut être obtenu via la méthode ISyncMgrSyncItemContainer ::GetSyncItemCount .

Exemples

L’exemple suivant montre une implémentation de cette méthode.

STDMETHODIMP CMyDeviceHandler::GetSyncItemEnumerator(
    __out IEnumSyncMgrSyncItems **ppenum)
{
    *ppenum = NULL;

    // Load the items using a private class method.
    HRESULT hr = _LoadItems();

    if (SUCCEEDED(hr))
    {
        hr = CEnumSyncMgrSyncItems_CreateInstance(this,
                                                  IID_PPV_ARGS(ppenum));
    }

    return hr;
}

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