L_OptGetDefaultOptions

#include "l_bitmap.h"

L_LTIMGOPT_API L_INT L_OptGetDefaultOptions(pOptImgOptions, uStructSize)

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

Parameters

pOPTIMIZEIMAGEOPTIONS pOptImgOptions

Pointer to the OPTIMIZEIMAGEOPTIONS structure to be updated with the default optimization options used for optimizing an image.

L_UINT uStructSize

Size in bytes, of the structure pointed to by pOptImgOptions, for versioning. Use sizeof(OPTIMIZEIMAGEOPTIONS).

Returns

Value Meaning
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

Platforms

Win32, x64.

Help Version 20.0.2019.10.13
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help