Collapse All Expand All

L_OptGetDefaultOptions

#include "l_bitmap.h"

L_LTIMGOPT_API L_INT L_OptGetDefaultOptions(pOptImgOptions, uStructSize)

pOPTIMIZEIMAGEOPTIONS pOptImgOptions;	/* pointer to the OPTIMIZEIMAGEOPTIONS structure */
L_UINT uStructSize;	/* size of the OPTIMIZEIMAGEOPTIONS structure */

Gets the default optimization options used by LEADTOOLS for optimizing an image.

Parameter	Description
pOptImgOptions	Pointer to the OPTIMIZEIMAGEOPTIONS structure to be updated with the default optimization options used for optimizing an image.
uStructSize	Size in bytes, of the structure pointed to by pOptImgOptions, for versioning. Use sizeof(OPTIMIZEIMAGEOPTIONS).

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Before calling this function, you must declare a variable of data type OPTIMIZEIMAGEOPTIONS. Then, pass the address of the variable in the pOptImgOptions parameter. The uStructSize parameter must be set to the size of the OPTIMIZEIMAGEOPTIONS structure in bytes. This function will update the variable with the default optimization options used for optimizing an image.

For more information, refer to the OPTIMIZEIMAGEOPTIONS structure.

This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.

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.

Platforms

Win32, x64.

See Also

Functions:	L_OptOptimizeBuffer, L_OptOptimizeDir
Topics:	Optimizer: Optimization Functions
	Image Optimization

Example

For an example, refer to L_OptOptimizeBuffer.