GetEvent-Methode

Wenn der dbmlsync-Server eine Synchronisation ausführt, generiert er eine Reihe von Ereignissen, die Informationen über den Verarbeitungsfortschritt der Synchronisation enthalten. Diese Ereignisse werden vom Server an die Klasse DbmlsyncClient gesendet, die sie in eine Warteschlange stellt. Wenn die GetEvent-Methode aufgerufen wird, wird die nächste Methode in der Warteschlange zurückgegeben, sofern dort eine wartet.

Syntax

DBSC_GetEventRet GetEvent(out DBSC_Event ev, UInt32 timeout)

Bemerkungen

Wenn keine Ereignisse in der Warteschlange vorhanden sind, wartet diese Methode, bis ein Ereignis verfügbar ist oder bis der angegebene Zeitablaufwert erreicht wurde, bevor sie beendet wird.

Die für eine Synchronisation generierten Ereignistypen können mit Eigenschaften gesteuert werden. Weitere Hinweise finden Sie unter SetProperty-Methode.

Parameter

ev Wenn der Rückgabewert DBSC_GETEVENT_OK ist, wird das Ereignis mit Informationen über ev gefüllt, das abgerufen wurde. Weitere Hinweise finden Sie unter DBSC_Event-Struktur.
timeout Gibt die maximale Anzahl von Millisekunden zurück, die gewartet werden soll, wenn kein Ereignis unmittelbar zur Rückgabe bereitsteht. Verwenden Sie DBSC_INFINITY, wenn ohne Zeitbeschränkung gewartet werden soll. Die DBSC_INFINITY-Konstante ist innerhalb der DbmlSyncClient-Klasse und nicht im Namespace definiert, daher müssen Sie der Konstanten ein Präfix voranstellen. Zum Beispiel: timeout = DbmlSyncClient.DBSC_INFINITY;.

Rückgabe

Gibt einen der folgenden Werte zurück:

Rückgabewert	Beschreibung
DBSC_GETEVENT_OK	Zeigt an, dass ein Ereignis erfolgreich abgerufen wurde.
DBSC_GETEVENT_TIMED_OUT	Zeigt an, dass der Zeitablaufwert erreicht wurde, ohne dass ein Ereignis für die Rückgabe verfügbar wurde.
DBSC_GETEVENT_FAILED	Zeigt an, dass aufgrund einer Fehlerbedingung kein Ereignis zurückgegeben wurde. Wenn DBSC_GETEVENT_FAILED zurückgegeben wird, können Sie die Methode GetErrorInfo aufrufen, um weitere Informationen über den Fehler zu erhalten. Weitere Hinweise finden Sie unter GetErrorInfo-Methode.

Kommentieren Sie diese Seite in DocCommentXchange.
Senden Sie uns Feedback über diese Seite via E-Mail.