ISyncMgrEventLinkUIOperation::Init method (syncmgr.h)

Enables Sync Center to provide the event to link to so ISyncMgrUIOperation::Run knows which event to operate upon.

Syntax

HRESULT Init(
  [in] REFGUID       rguidEventID,
  [in] ISyncMgrEvent *pEvent
);

Parameters

[in] rguidEventID

Type: REFGUID

A reference to the event ID that is being stored. This parameter is the same as what is returned from the GetEventID method of the pEvent parameter.

[in] pEvent

Type: ISyncMgrEvent*

A pointer to the ISyncMgrEvent object for Run to use. This is the event object that owns the link.

Return value

Type: HRESULT

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

Remarks

The event ID is the ID that the handler is given when ReportEvent is called, or is the ID provided by the handler when the event is obtained from the custom event store.

If you call ReportEvent, your events will be stored only until the user logs off or until the handler is synchronized again.

The interface that is used to implement custom event stores is ISyncMgrEventStore.

The ISyncMgrEvent provided in the pEvent parameter is not the same object that came from a custom event store.

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