ISyncMgrSyncItemContainer::GetSyncItemEnumerator-Methode (syncmgr.h)

Artikel
03/02/2024

Ruft eine Schnittstelle ab, die die Synchronisierungselemente des Handlers aufzählt.

Syntax

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

Parameter

[out] ppenum

Typ: IEnumSyncMgrSyncItems**

Wenn diese Methode zurückgibt, enthält die Adresse eines Zeigers auf eine IEnumSyncMgrSyncItems-instance. IEnumSyncMgrSyncItems kann verwendet werden, um eine Schnittstelle für jedes Synchronisierungselement im Satz abzurufen.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Diese Methode ersetzt die ältere EnumSyncMgrItems-Methode . Die ältere Methode hat eine Enumeratorschnittstelle zurückgegeben, die eine SYNCMGRITEM-Struktur für jedes Synchronisierungselement zurückgibt. Um die zuvor von dieser Struktur bereitgestellten Daten abzurufen, ruft das Synchronisierungscenter QueryInterface auf der ISyncMgrSyncItem-Schnittstelle jedes Elements auf, um eine entsprechende ISyncMgrSyncItemInfo-Schnittstelle anzufordern.

Die Anzahl der aufgezählten Elemente kann über die ISyncMgrSyncItemContainer::GetSyncItemCount-Methode abgerufen werden.

Beispiele

Das folgende Beispiel zeigt eine Implementierung dieser Methode.

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;
}

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	syncmgr.h

Freigeben über