As the dbmlsync server runs a synchronization it generates a series of events that contain information about the progress of the synchronization. These events are sent from the server to the DbmlsyncClient class, which queues them. When the GetEvent method is called, the next event in the queue is returned if there is one waiting.
DBSC_GetEventRet GetEvent(out DBSC_Event ev, UInt32 timeout)
If there are no events waiting in the queue, this method waits until an event is available or until the specified timeout has expired before returning.
The types of event that are generated for a synchronization can be controlled using properties. See SetProperty method.
ev If the return value is DBSC_GETEVENT_OK then the event is filled in with information about the event that has been retrieved. See DBSC_Event structure.
timeout Specifies the maximum number of milliseconds to wait if no event is immediately available to return. Use DBSC_INFINITY to
wait forever. The DBSC_INFINITY constant is defined within the DbmlSyncClient class and not in the namespace, so you need
to preface the constant. For example, timeout = DbmlSyncClient.DBSC_INFINITY;.
Returns one of the following:
| Return value | Description |
|---|---|
| DBSC_GETEVENT_OK |
Indicates that an event was successfully retrieved. |
| DBSC_GETEVENT_TIMED_OUT |
Indicates that the timeout expired without any event being available to return. |
| DBSC_GETEVENT_FAILED |
Indicates that no event was returned because of an error condition. When DBSC_GETEVENT_FAILED is returned, you can call the GetErrorInfo method to get more information about the failure. See GetErrorInfo method. |
| Discuss this page in DocCommentXchange. Send feedback about this page using email. |
Copyright © 2009, iAnywhere Solutions, Inc. - SQL Anywhere 11.0.1 |