Click here to view and discuss this page in DocCommentXchange. In the future, you will be sent there automatically.

SQL Anywhere 11.0.1 (中文) » MobiLink - 客户端管理 » 用于 MobiLink 的 SQL Anywhere 客户端 » Dbmlsync API » 适用于 C++ 的 Dbmlsync API

 

GetEvent 方法

当 dbmlsync 服务器运行同步时,它会生成一系列包含同步进度信息的事件。这些事件会从服务器发送到 DbmlsyncClient 类,DbmlsyncClient 类会对其排序。调用 GetEvent 方法时,如果有一个正在等待的事件,则将返回队列中的下一个事件。

语法
DBSC_GetEventRet GetEvent( DBSC_Event **event, unsigned timeout )
注释

如果队列中没有等待的事件,则此方法将等待事件变为可用或者指定的超时到期后再返回。

可使用属性控制为同步所生成的事件的类型。请参见SetProperty 方法

参数
  • event   如果返回值为 DBSC_GETEVENT_OK,则此事件参数是由指向 DBSC_Event 结构(包含关于已检索事件的信息)的指针填充的。当您用完事件结构时,必须调用 FreeEventInfo 方法以释放与其关联的内存。请参见DBSC_Event 结构FreeEventInfo 方法

  • timeout   如果没有可立即返回的事件,则指定等待的最大毫秒数。使用 DBSC_INFINITY 可一直等待。

返回值

返回下列值之一:

  • DBSC_GETEVENT_OK   表示成功检索了事件。

  • DBSC_GETEVENT_TIMED_OUT   表示在出现任何可返回的事件之前超时已过期。

  • DBSC_GETEVENT_FAILED   表示由于出现错误状况而无法返回事件。返回 DBSC_GETEVENT_FAILED 时,您可调用 GetErrorInfo 方法获取有关此方法失败原因的详细信息。请参见GetErrorInfo 方法