|
<< Click to Display Table of Contents >> CBPROGRESSDesc (progress callback) |
![]() ![]()
|
The progress callback enables the client to be kept up to date as to the progress of a potentially long-running operation (such as DbiBatchMove or DbiQExec). When the client registers the callback, a callback buffer must be supplied. The buffer must be at least as large as sizeof(CBPROGRESSDesc). During query execution, the supplied callback function is called after certain milestones have been reached, giving the client an update on how execution is progressing. The CBPROGRESSDesc structure is stored in the client's call back buffer.
The CBPROGRESSDesc structure contains the following fields:
Field |
Type |
Description |
iPercentDone |
UINT16 |
Any number from -1 to 100 is valid. A value between 1 and 100 specifies the percentage done; for example, the value 50 indicates that the execution is half complete. If the value is -1, the progress of execution is indicated via the string szMsg, rather than with a percentage. |
szMsg |
DBIMSG |
Specifies a string containing a message. This message serves as a progress report; for example, "Steps completed: 5." The message is displayed when iPercentDone is -1. |