iscEngineSetListener() registers the user-defined listener function with the synchronization engine. During a synchronization session, the listener function is called when a synchronization event (such as a starting synchronization) or an error occurs.
Syntax
isy_INT32 iscEngineSetListener(
HISCENG hEngine,
iscEngineListenerPF syncListener,
isy_UINT32 syncListenerData);
Function arguments
ǥ 138 lists the valid arguments used
with the iscEngineSetListener() function.
ǥ 138. iscEngineSetListener() arguments
| Data type | Argument | Use | Description |
|---|---|---|---|
| HISCENG | hEngine | input | Handle to the synchronization engine |
| iscEngineListenerPF | syncListener | input | Address of the user-defined listener function |
| isy_UINT32 | syncListenerData | input | Data that the application wants to forward to the user-define listener function |
Usage
By registering a user-defined listener function, the application has a view into the synchronization process. The application is notified when events or errors occur during synchronization. The application can customize methods to present these events or errors to the users.
Example:
// 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);
Return codes
Restrictions
The user-defined listener function should follow the protocol of the synchronization engine, or the synchronization engine might not work correctly.
Related concepts
Related tasks
Related reference