Registers an user callback method that is invoked periodically during long running calls to
exec , and step for this database connection. An example use
for this interface is to keep a GUI updated during a large query.
| Arguments: |
The arguments are:
| callBackObj [required] |
An instantiated object with a method that will be invoked during long runningexecorstepmethods.
However, this argument can also be .nil to indicate that any installed progress handler is to be removed.
|
| instrcts [required] |
The number of virtual machine instructions that are evaluated between successive invocations of the callback. If
this argument is less than 1, it also has the effect of removing any installed callback.
|
| mName [optional] |
The method name that will be invoked during a call back. By default, the method invoked will beprogressCallBack(). However, the user can specify an alternative method if desired.
This argument is ignored when thecallbackObjargument is .nil.
|
| uData [optional] |
This can be any Rexx object the user desires. The object will be sent as the first and only argument to the progress
handler callback method when it is invoked. This argument is ignored when the callbackObj argument is .nil.
|
|
| Return value: |
Returns a SQLite result Result Code Constants .
|
| Remarks: |
By default, there is no progress handler installed. There can only be one progress handler per database connection.
Setting a new progress handler automatically clears any previously installed handler.
|
| Details: |
The functionality of theprogressHandlermethod is similar to that of the SQLite
sqlite3_progress_handler API.
|
