Cancels a synchronization process.
To cancel |
Use |
---|---|
System function |
|
Synchronization object function |
Closes the window associated with a current synchronization process.
CancelSync (windowclassname)
Argument |
Description |
---|---|
windowclassname |
A read-only string for the handle to the window receiving synchronization messages |
Long. Returns 1 for success and -1 for failure.
If you use the MobiLink Synchronization for ASA wizard, it is typically not necessary to call CancelSync explicitly. This is because the uf_cancelsync function of the wizard-generated user object makes an equivalent call to pb_cancel_dbmlsync in the PocketBuilder VM. (The uf_cancelsync function is called, for example, in the Clicked event of the Cancel button on the wizard-generated synchronization window.)
Reserved for future use. Cancels the synchronization process and rolls back any changes accumulated during the processing.
MLSynchronization, MLSync controls
SyncObject.CancelSync ( )
Argument |
Description |
---|---|
syncObject |
The name of the synchronization object that started a synchronization process that you want to stop. |
Integer. Returns 1 for success and -1 for failure.