GetTransactionProgress

Definition:

GetTransactionProgress(tag)

 

Description:

Query how much of an asynchronous data transaction has completed.

 

Platforms:

All

 

Parameters:

tag - required

This parameter is not currently used. Enter an empty string, "", to obtain the progress of the currently active asynchronous data transaction.

 

Returns:

int

Percentage of transfer completed since transaction started. Can be any number from zero to 100.

 

Notes:

This Method can be used to check how much of an ongoing asynchronous data transaction has completed. The synchronisation must have been initiated by a previous call to the Synchronise Method and the transfer must be asynchronous.


See also:

Synchronise

CancelTransaction

GetTransactionState

GetNumSyncErrors

GetSyncErrorDataSource

GetSyncErrorRecordIndex