CancelSync

Cancels a synchronization process.

To cancel

Use

System function

Syntax 1 System function

Synchronization object function

Syntax 2 Synchronization object function


Syntax 1 System function

Description

Closes the window associated with a current synchronization process.

Syntax

CancelSync (windowclassname)

Argument

Description

windowclassname

A read-only string for the handle to the window receiving synchronization messages

Returns

Long. Returns 1 for success and -1 for failure.

Usage

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.)

See also


Syntax 2 Synchronization object function

Description

Reserved for future use. Cancels the synchronization process and rolls back any changes accumulated during the processing.

Applies to

MLSynchronization, MLSync controls

Syntax

SyncObject.CancelSync ( )

Argument

Description

syncObject

The name of the synchronization object that started a synchronization process that you want to stop.

Returns

Integer. Returns 1 for success and -1 for failure.