iscEngineSetListener()

目的

iscEngineSetListener() は、ユーザー定義のリスナー関数を同期エンジンに登録します。 リスナー関数は、同期セッション中に、同期イベント (同期化の開始など) またはエラーが発生した際に呼び出されます。

構文

isy_INT32 iscEngineSetListener(
    HISCENG             hEngine,
    iscEngineListenerPF syncListener,
    isy_UINT32          syncListenerData);

関数の引き数

表 138 は、iscEngineSetListener() 関数で使用される有効な引き数をリストしたものです。

表 138. iscEngineSetListener() の引き数

使用法

ユーザー定義のリスナー関数を登録することによって、アプリケーションは同期化処理を表示することができます。 同期化中にイベントまたはエラーが発生すると、アプリケーションに通知されます。 アプリケーションでは、これらのイベントまたはエラーをユーザーに表示するメソッドをカスタマイズすることができます。

例:

// Function syncListener is defined with the following prototype:
isy_INT32 mySyncListener(
    isy_UINT32 listenerData,
    ISCEVT*  event,
    isy_VOID*  pExtraInfo);
...
// Handle to the synchronization engine is passed to the listener function
iscEngineSetListener(hEngine, mySyncListener, (isy_UINT32) hEngine);

戻りコード

• ISCRTN_Succeeded: 正常
• ISCRTN_Failed: その他

制約事項

ユーザー定義のリスナー関数は、同期エンジンのプロトコルに従わなければなりません。 従わない場合、同期エンジンが正しく動作しない可能性があります。

関連した概念

• 同期クライアント C/C++ サンプル・アプリケーション

関連したタスク

• C/C++ を使用した DB2 Everyplace 同期クライアント・アプリケーションの開発

関連した解説

• IBM 同期クライアント C-API バージョン 8.1 と バージョン 7.2 の比較
• IBM 同期クライアント C-API のデータ・タイプ
• IBM 同期クライアント C-API の関数の要約
• iscEngineSync()