Xbasic

UpdateBegin Function

Syntax

UpdateBegin( Context as P, RowsExpected as N, BYREF ProgressInterval as N, [ BYREF Cancel as L ] )

Arguments

Context

The object on which the function is called (generally the connection or a result set).

RowsExpected

The number of rows to be updated. Note: The number of rows in an applied result set is not always known. In this case, RowsExpected will be -1.

ProgressInterval

Indicates how many rows will be processed before the UpdateProgress event will be invoked. You can change the value.

Cancel

Optional. Default = .F. To cancel the execution of the event, set Cancel = .T. A value of .T. prevents the calling of UpdateEnd.

Description

AlphaDAO calls UpdateBegin()when it about to process a batch of updates. This event is useful for displaying a progress/cancel dialog.

Limitations

Desktop applications only.

See Also