Edit

ISyncMgrEventStore::GetEventEnumerator method (syncmgr.h)

  • Article

Gets an enumerator for a handler's events.

Syntax

HRESULT GetEventEnumerator(
  [out] IEnumSyncMgrEvents **ppenum
);

Parameters

[out] ppenum

Type: IEnumSyncMgrEvents**

When this method returns, contains the address of a pointer to an IEnumSyncMgrEvents instance that can be used to access the handler's events.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method is called by Sync Center when the user navigates to the Sync Results folder or clicks the Errors link for a handler.

Examples

The following example shows an implementation of ISyncMgrEventStore::GetEventEnumerator.

STDMETHODIMP CMyDeviceEventStore::GetEventEnumerator(
                                __out IEnumSyncMgrEvents **ppenum)
{
    HRESULT hr = CEnumMyDeviceSyncMgrEvents_Create(ppenum);
    return hr;
}

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header syncmgr.h