Метод ISyncMgrSyncItemContainer::GetSyncItemEnumerator (syncmgr.h)

Возвращает интерфейс, перечисляющий элементы синхронизации обработчика.

Синтаксис

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

Параметры

[out] ppenum

Тип: IEnumSyncMgrSyncItems**

При возврате этого метода содержит адрес указателя на экземпляр IEnumSyncMgrSyncItems . IEnumSyncMgrSyncItems можно использовать для получения интерфейса для каждого элемента синхронизации в наборе.

Возвращаемое значение

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Этот метод заменяет старый метод EnumSyncMgrItems . Старый метод возвращал интерфейс перечислителя, который возвращал структуру SYNCMGRITEM для каждого элемента синхронизации. Чтобы получить данные, ранее предоставленные этой структурой, Центр синхронизации вызывает QueryInterface в интерфейсе ISyncMgrSyncItem каждого элемента, чтобы запросить соответствующий интерфейс ISyncMgrSyncItemInfo .

Количество перечисляемых элементов можно получить с помощью метода ISyncMgrSyncItemContainer::GetSyncItemCount .

Примеры

В следующем примере показана реализация этого метода.

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

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2008 [только классические приложения]
Целевая платформа Windows
Header syncmgr.h