Allows a client to cancel a synchronization request previously made using the Sync method.

Syntax

bool CancelSync( DBSC_SyncHdl hdl )

Remarks

Only synchronization requests waiting to be serviced can be cancelled. The server does not cancel a synchronization once it has begun.

A connection must be established to the server before this method can be used. This method cannot be used if the client has disconnected from the server since the Sync method was called.

Parameters

Return value

Returns true if the synchronization request was successfully canceled.

Returns false if the synchronization request was not canceled. When false is returned, you can call the GetErrorInfo method to get more information about the failure. See GetErrorInfo method.