STATUSCALLBACK Function
#include "l_bitmap.h"
L_INT pEXT_CALLBACK YourFunction(nPercentComplete, pUserData)
|
L_INT nPercentComplete; |
/* completion percentage */ |
|
/* pointer to additional parameters */ |
Lets you update a status bar or interrupt the calling function’s operation.
|
Parameter |
Description |
|
nPercentComplete |
An integer from 0 to 100 that indicates the completion percentage of the function that uses the callback. |
|
pUserData |
A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of the calling function.) |
|
|
Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This generalized callback function can be called by many different functions. If the callback function returns a failure, the calling function will terminate and return the same error that the callback returned. For a description of how the callback is used, refer to L_SetStatusCallBack.
Example
For an example, refer to L_SetStatusCallBack.