ISyncMgrSyncCallback::ReportEvent-Methode (syncmgr.h)

Stellt ein Ereignis bereit, das dem Ordner "Synchronisierungsergebnisse" für ein Element hinzugefügt werden soll, das synchronisiert wird.

Syntax

HRESULT ReportEvent(
  [in]  LPCWSTR             pszItemID,
  [in]  SYNCMGR_EVENT_LEVEL nLevel,
  [in]  SYNCMGR_EVENT_FLAGS nFlags,
  [in]  LPCWSTR             pszName,
  [in]  LPCWSTR             pszDescription,
  [in]  LPCWSTR             pszLinkText,
  [in]  LPCWSTR             pszLinkReference,
  [in]  LPCWSTR             pszContext,
  [out] GUID                *pguidEventID
);

Parameter

[in] pszItemID

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der die eindeutige ID des Elements enthält, das gerade synchronisiert wird. Diese Zeichenfolge hat eine maximale Länge MAX_SYNCMGR_ID einschließlich des endenden NULL-Zeichens .

[in] nLevel

Typ: SYNCMGR_EVENT_LEVEL

Ein Wert aus dem SYNCMGR_EVENT_LEVEL Enumeration, der den Typ des beteiligten Ereignisses deklariert.

[in] nFlags

Typ: SYNCMGR_EVENT_FLAGS

Wird nicht verwendet.

[in] pszName

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der den Namen des Ereignisses enthält.

[in] pszDescription

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der eine Beschreibung des Ereignisses enthält.

[in] pszLinkText

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der den Text enthält, der in einem Link zum Element verwendet werden soll. Dieser Parameter kann NULL sein.

[in] pszLinkReference

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der die URL des Elements enthält. Dieser Parameter kann NULL sein.

[in] pszContext

Typ: LPCWSTR

Handlerspezifische Daten, die dem Ereignis zugeordnet werden sollen.

[out] pguidEventID

Typ: GUID*

Wenn diese Methode zurückgibt, enthält einen Zeiger auf eine eindeutige ID für das Ereignis.

Rückgabewert

Typ: HRESULT

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

Hinweise

Damit der Handler dem Benutzer weitere Details zum Synchronisierungsergebnis bereitstellt, kann das Eigenschaftenblatt für einzelne Synchronisierungsergebnisse erweitert werden, die vom Handler gemeldet werden.

Diese Methode ersetzt LogError.

Das Ereignis wird nur im Arbeitsspeicher gespeichert, sodass alle Ereignisse gelöscht werden, wenn sich der Benutzer abmeldet oder herunterfährt. Dies ist ein Grund, einen benutzerdefinierten ISyncMgrEventStore zu implementieren, der seine Ereignisse von überall aus bereitstellen kann, einschließlich einer Datei, über das Netzwerk oder die Registrierung. Der Ordner "Synchronisierungsergebnisse" zeigt jedoch Ereignisse an, die sowohl vom internen Ereignisspeicher als auch von benutzerdefinierten Ereignisspeichern bereitgestellt werden, die von Synchronisierungshandlern bereitgestellt werden.

Beispiele

Das folgende Beispiel zeigt die Verwendung von ISyncMgrSyncCallback::ReportProgress durch die Synchronize-Methode .

STDMETHODIMP CMyDeviceHandler::Synchronize(...)
{
    ...
    // Get the event receiver interface.
    ISyncMgrEventReceiver *pEventReceiver = NULL;
    hr = pCallback->QueryInterface(IID_ISyncMgrEventReceiver,
                                   (void **) &pEventReceiver);

    ...

    // Start synchronizing the sync item.

    ...

    // Generate a GUID for this item.
    // Construct a string to display in the Sync Results folder.
    // Store the information about this event so we can display more details.
    // Report the event to Sync Center.
    hr = pEventReceiver->ReportEvent(pszItemID,
                                     SYNCMGR_EL_INFORMATION,
                                     SYNCMGR_EF_NONE,
                                     pszEventName,
                                     pszEventDescription,
                                     NULL,
                                     NULL,
                                     NULL,
                                     &guidEventID);
    ...
}

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