GetEvent メソッド

dbmlsync サーバは、同期を実行しながら、同期の進行状況に関する情報を含む一連のイベントを生成します。これらのイベントは、サーバから DbmlsyncClient クラスに送信され、そこでキューイングされます。GetEvent メソッドを呼び出すと、キュー内で待機している次のイベントがある場合、そのイベントが返されます。

構文

DBSC_GetEventRet GetEvent( DBSC_Event **event, unsigned timeout )

備考

キュー内で待機しているイベントがない場合、このメソッドは、イベントが実行可能になるまで、または指定されたタイムアウトになるまで待ってから、戻ります。

同期用に生成されるイベントのタイプは、プロパティを使用して制御できます。SetProperty メソッドを参照してください。

パラメータ

event 戻り値が DBSC_GETEVENT_OK である場合、event パラメータに、取得されたイベントに関する情報を含む DBSC_Event 構造体へのポインタが入力されます。event の構造体を使い終わったら、FreeEventInfo メソッドを呼び出して、event の構造体に関連付けられていたメモリを解放してください。DBSC_Event 構造体とFreeEventInfo メソッドを参照してください。
timeout すぐに返すことができるイベントがない場合に待つ最大のミリ秒数を指定します。待ち時間を制限しない場合は、DBSC_INFINITY を使用します。

戻り値

次のいずれかを返します。

DBSC_GETEVENT_OK イベントが正常に取得されたことを示します。
DBSC_GETEVENT_TIMED_OUT 返すことができるイベントがないまま、タイムアウトになったことを示します。
DBSC_GETEVENT_FAILED エラーが発生したためにイベントが返されなかったことを示します。DBSC_GETEVENT_FAILED が返されたときは、GetErrorInfo メソッドを呼び出して、メソッドが失敗した原因の詳細を調べることができます。GetErrorInfo メソッドを参照してください。