GetEvent メソッド

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

構文

DBSC_GetEventRet GetEvent(out DBSC_Event ev, UInt32 timeout)

備考

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

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

パラメータ

ev 戻り値が DBSC_GETEVENT_OK である場合、ev に、取得されたイベントに関する情報が入力されます。DBSC_Event 構造体を参照してください。
timeout すぐに返すことができるイベントがない場合に待つ最大のミリ秒数を指定します。待ち時間を制限しない場合は、DBSC_INFINITY を使用します。DBSC_INFINITY 定数はネームスペースではなく DbmlSyncClient クラス内で定義されているので、定数にはプレフィクスが必要です(例：timeout = DbmlSyncClient.DBSC_INFINITY;)。

戻り値

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

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