LEADTOOLS Raster Imaging C DLL Help
| LEADTOOLS Raster Imaging C DLL Help > Function References > Callback Functions > OPTIMIZEBUFFERCALLBACK Function |
#include "l_bitmap.h"
L_INT pEXT_CALLBACK YourFunction (nPercent, pUserData)
|
L_INT nPercent; |
/* percentage completion of optimizing a buffer.*/ |
|
L_VOID * pUserData; |
/* pointer to additional parameters */ |
This callback function is called repeatedly by the L_OptOptimizeBuffer function to notify the user of the percentage of the optimization operation that has been completed. The callback function is called for every 1% of optimization that is completed.
|
Parameter |
Description |
|
nPercent |
An integer from 0 to 100 that indicates the completion percentage of the buffer optimization operation. |
|
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 L_OptOptimizeBuffer function. (This is the same pointer that you pass in the pUserData parameter of L_OptOptimizeBuffer 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
If the callback function returns a failure, the L_OptOptimizeBuffer will terminate and return the same error that the callback returned.
Required DLLs and Libraries
|
LTIMGOPT For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application |
See Also
|
Functions: |
L_OptOptimizeBuffer, L_OptGetDefaultOptions, L_OptOptimizeDir, OPTIMIZEIMAGEDIRCALLBACK. |
|
Topics: |
Example
For an example, refer to L_OptOptimizeBuffer.
