L_FreeFilterData

Summary

Frees the filter data information obtained using L_FileInfo.

Syntax

#include "l_bitmap.h"

L_LTFIL_API L_INT L_FreeFilterData(nFilter, pFilterData, uFilterDataSize, bLoad)

Parameters

L_INT nFilter

Indicates which filter allocated this structure. Pass the value retrieved from FILEINFO.nFilter.

L_VOID *pFilterData

Pointer to the filter data. Pass the value retrieved from FILEINFO.pFilterData.

L_SIZE_T uFilterDataSize

Indicates the size of the filter data (usually 0). Pass the value retrieved from FILEINFO.nFilter.

L_BOOL bLoad

Indicates whether the filter data is used for loading or saving.Currently, only the load mechanism supports filter data, so always pass L_TRUE.

Returns

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

Comments

This function should be called to free the filter data obtained from L_FileInfo. Call this function when the filter data is not needed anymore. See Using Filter Data to Speed up Loading Large Files for more information.

Note: There is a function, called L_FreeFilterInfo, that has a name similar to L_FreeFilterData.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to Using Filter Data to Speed up Loading Large Files.

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

LEADTOOLS Raster Imaging C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.