ISyncMgrControl::UpdateEvents-Methode (syncmgr.h)

Artikel
08/26/2023

Informiert das Synchronisierungscenter darüber, dass Ereignisse für einen bestimmten Handler oder ein bestimmtes Element hinzugefügt wurden.

Syntax

HRESULT UpdateEvents(
  [in] LPCWSTR               pszHandlerID,
  [in] LPCWSTR               pszItemID,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Parameter

[in] pszHandlerID

Typ: LPCWSTR

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

[in] pszItemID

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der die eindeutige ID des Elements enthält. Diese Zeichenfolge hat eine maximale Länge MAX_SYNCMGR_ID einschließlich des endenden NULL-Zeichens . Dieser Parameter kann NULL sein, wenn das Ereignis nicht für ein bestimmtes Element, sondern für den Handler aufgetreten ist.

[in] nControlFlags

Typ: SYNCMGR_CONTROL_FLAGS

Ein Wert aus der SYNCMGR_CONTROL_FLAGS -Enumeration, die angibt, ob das Update synchron oder asynchron ausgeführt werden soll.

Rückgabewert

Typ: HRESULT

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

Hinweise

Wenn SYNCMGR_CF_WAIT im nControlFlags-Parameter festgelegt ist, wird UpdateEvents erst zurückgegeben, wenn das Synchronisierungscenter den angegebenen Handler geladen, den Ereignisspeicher des Handlers abgerufen und alle Ereignisse aus diesem Speicher neu geladen hat. Wenn der Handler von einer Handlerauflistung bereitgestellt wird, wird auch die Handlerauflistung geladen, um den Handler erneut zu laden.

Beispiele

Das folgende Beispiel zeigt die Verwendung von ISyncMgrControl::UpdateEvents durch die Prozedur eines Handlers.

void CMyDeviceHandler::Synchronize(...)
{
    ...
    // Add events to the event store.

    // Get the Sync Center control object.
    ISyncMgrControl *pControl = NULL;
    
    hr = CoCreateInstance(CLSID_SyncMgrControl, 
                          CLSCTX_SERVER, 
                          IID_PPV_ARGS(&pControl));
    if (SUCCEEDED(hr))
    {
        // Tell Sync Center that we added events to our event store.
        // By passing NULL in pszItemID, we tell Sync Center that the event
        // occurred on the handler rather than a specific item.
        hr = pControl->UpdateEvents(s_szMyDeviceSyncHandlerID, 
                                    NULL,
                                    SYNCMGR_CF_NOWAIT);
        pControl->Release();
    }

    ...

}

Anforderungen


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