OPTIMIZEIMAGEDIRCALLBACK Function
#include "l_bitmap.h"
L_INT pEXT_CALLBACK YourFunction (pOptImgDirInfo, pUserData)
pOPTIMIZEIMAGEDIRINFO pOptImgDirInfo; |
/* pointer to optimization Info structure */ |
/* pointer to additional parameters */ |
Gives the user information about the image(s) being optimized by L_OptOptimizeDir.
Parameter |
Description |
pOptImgDirInfo |
Pointer to an OPTIMIZEIMAGEDIRINFO structure that contains information about the image(s) being optimized, such as the completion percentage for the current image being optimized, and the completion percentage for all files being optimized. |
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_OptOptimizeDir function. (This is the same pointer that you pass in the pUserData parameter of L_OptOptimizeDir 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. |
ERROR_OPT_SKIPIMAGE |
Skip the current image and optimize the next image. |
Any other value |
An error occurred. Stop the whole optimization operation. Refer to Return Codes. |
Comments
To skip the current image being processed and continue optimizing the next image, have this function return ERROR_OPT_SKIPIMAGE.
If the callback function returns a failure, the L_OptOptimizeDir will terminate and return the same error that the callback returned.
See Also
Functions: |
L_OptOptimizeBuffer, L_OptGetDefaultOptions, L_OptOptimizeDir, OPTIMIZEBUFFERCALLBACK, OPTIMIZEIMAGEDIRINFO |
Topics: |
Example
For an example, refer to L_OptOptimizeDir.