In This Topic ▼

L_FreeFilterInfo

#include "l_bitmap.h"

L_LTFIL_API L_INT L_FreeFilterInfo(pFilterInfo, uFilterCount, uFlags)

Frees all filters information allocated by calling the L_GetFilterListInfo function; or frees the information about a specific filter obtained in the pFilterInfo parameter by calling the L_GetFilterInfo function.

Parameters

pFILTERINFO pFilterInfo

Pointer to FILTERINFO structure to be freed. This parameter cannot be NULL. This pointer points either to an array of information for all filters obtained by L_GetFilterListInfo function; or points to information of a specific filter obtained by L_GetFilterInfo function.

L_UINT uFilterCount

Value that represents the number of elements of the pFilterInfo parameter. Possible values are:

Value	Meaning
1	Free only the memory stored inside the pFilterInfo parameter obtained by the L_GetFilterInfo function.
> 1	Free the memory allocated in the array of information for all filters obtained in the ppFilterList parameter by calling L_GetFilterListInfo function.

L_UINT uFlags

Flags that indicate whether to free the memory stored inside the pFilterInfo parameter obtained by the L_GetFilterInfo; or free the memory allocated in the array of information for all filters obtained in the ppFilterList parameter by calling L_GetFilterListInfo function. Possible values are:

Value	Meaning
0	Free the memory stored inside the pFilterInfo parameter obtained by the L_GetFilterInfo.
FILTERINFO_FREEALL	[0x0020] Free the memory allocated in the array of information for all filters obtained in the ppFilterList parameter by calling L_GetFilterListInfo function.

Returns

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

Comments

To free the memory allocated in the array of information for all filters obtained in the ppFilterList parameter by calling L_GetFilterListInfo function, call L_FreeFilterInfo as follows:

L_FreeFilterInfo (pFilterInfo, uFilterCount, FILTERINFO_FREEALL);

The number of elements in the array can be obtained in the pFilterCount parameter of the L_GetFilterListInfo function.

To free the memory stored inside the pFilterInfo parameter obtained by calling L_GetFilterInfo, call L_FreeFilterInfo as follows:

L_FreeFilterInfo(pFilterInfo, 1, 0);

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

Use L_FreeFilterData to free the information obtained by calling L_FileInfo.
Use L_FreeFilterInfo to free the information obtained by calling L_GetFilterListInfo function or L_GetFilterInfo.

Required DLLs and Libraries