L_FreeFilterData

#include "l_bitmap.h"

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

L_INT nFilter;

indicates which filter allocated this structure

L_VOID *pFilterData;

pointer to the filter data

L_SIZE_T uFilterDataSize;

size of the filter data structure

L_BOOL bLoad;

indicates whether this was used for load or save

Frees the filter data information obtained using L_FileInfo.

Parameter

Description

nFilter

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

pFilterData

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

uFilterDataSize

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

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

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

LTFIL

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.

Help Version 20.0.2018.2.25
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help