iscEngineSetListener()

用途

iscEngineSetListener() 向同步引擎注册用户定义的侦听器函数。在同步会话期间,当发生同步事件(如正在启动的同步)或出错时,将调用侦听器函数。

语法

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

函数自变量

表 138 列示用于 iscEngineSetListener() 函数的有效自变量。

表 138. iscEngineSetListener() 自变量

数据类型 自变量 使用 描述
HISCENG hEngine 输入 同步引擎的句柄
iscEngineListenerPF syncListener 输入 用户定义的侦听器函数的地址
isy_UINT32 syncListenerData 输入 应用程序要转发到用户定义的侦听器函数的数据

用法

通过注册用户定义的侦听器函数,应用程序具有进入同步过程的视图。 在同步期间,当发生事件或错误时通知应用程序。 应用程序可以定制方法来对用户显示这些事件或错误。

示例:

// 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);        

返回码

限制

用户定义的侦听器函数应遵循同步引擎的协议,否则同步引擎可能无法正常工作。

相关概念

相关任务

相关参考