cbGENPROGRESS

pCbBuf is assumed to be of the type cbPROGRESSDesc. This callback is issued by BDE to inform applications about the progress made during large batch operations, such as DbiBatchMove. The Generic Progress Report callback allows the client to obtain progress reports during an operation, and to cancel the operation, if desired. The client registers a progress callback function using cbGENPROGRESS as the value for ecbType. The body of the progress callback function (written by the client) should cast the callback buffer as a structure of type cbPROGRESSDesc.

The BDE returns either a percentage done (returned in the iPercentDone parameter of the cbPROGRESSDesc structure), or a message string to display on the status bar. The client should assume the following: if the iPercentDone value is negative, then the message string is valid; otherwise, the iPercentDone value should be considered. The message string format should always be <Text String><:><Value> to allow easy international translations. For example,

Records copied: 250

In the message string, the value and colon fields are optional. Possible return values are: cbrABORT (stop processing), or cbrCONTINUE (continue processing).