iscEngineSync() launches a synchronization session.
Syntax
isy_INT32 iscEngineSync(
HISCENG hEngine);
Function arguments
Table 149 lists the valid argument used with the
iscEngineSync() function.
Table 149. iscEngineSync() argument
| Data type | Argument | Use | Description |
|---|---|---|---|
| HISCENG | hEngine | input | Handle to the synchronization engine |
Usage
Use iscEngineSync() to launch a synchronization session that synchronizes the configuration that is specified in iscEngineOpen(). A subscription set is in reset mode if that subscription set has never been synchronized. When the sync engine performs a synchronization on that subscription set, the sync client fetches the data from the Sync Server; this process is called a refresh. After the refresh completes, the sync engine synchronizes the changed data when the subscription set is synchronized again; this process is called a synchronize. The sync engine always synchronizes the configuration first. If the configuration synchronization fails, the sync engine does not continue processing the subsequent subscription sets, and the synchronization session stops. If the sync engine fails on one subscription set (but not on the configuration), the sync engine continues processing the remaining subscription sets, if any.
Return codes
The return code of iscEngineSync() is the aggregate (following the precedence listed below) of the sync status for all the subscription sets it has synchronized:
ISCRTN_Canceled > ISCRTN_Failed > ISCRTN_Succeeded
Restrictions
None.
Related concepts
Related tasks
Related reference