L_FreeFilterInfo
#include "l_bitmap.h"
L_LTFIL_API L_INT L_FreeFilterInfo(pFilterInfo, uFilterCount, uFlags)
|
pFILTERINFO pFilterInfo; |
/* pointer to FILTERINFO structure */ |
|
L_UINT uFilterCount; |
/* number of elements in an array */ |
|
L_UINT uFlags; |
/* flags */ |
Frees all the filters information allocated by calling the L_GetFilterListInfo function; or frees the information of a specific filter obtained in pFilterInfo parameter by calling the L_GetFilterInfo function.
|
Parameter |
Description |
|
|
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. |
|
|
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. |
|
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
|
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 this function as the following:
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 the L_GetFilterInfo, call this function as the following:
L_FreeFilterInfo(pFilterInfo, 1, 0);
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
Windows 2000 / XP/Vista, Windows CE.
See Also
|
Functions: |
L_GetFilterListInfo, L_GetFilterInfo, L_SetFilterInfo, L_FileInfo |
|
Topics: |
|
|
|
Example
For an example, refer to L_GetFilterListInfo.