Available in LEADTOOLS Imaging Pro, Vector, Document, and Medical Imaging toolkits. |
LFileSettings::GetIgnoreFilters
#include "ltwrappr.h"
static L_SSIZE_T LFileSettings::GetIgnoreFilters(pszFilters, uSize)
L_TCHAR * pszFilters; |
/* character string to be updated with filters */ |
L_SIZE_T uSize; |
/* size in bytes of pszFilters */ |
Retrieves the current ignored filters list that LEADTOOLS should NEVER load, even if present.
Parameter |
Description |
pszFilters |
Pointer to a character string to be updated with the current ignored filters list. |
uSize |
The size in bytes of the buffer pointed to by pszFilters. |
Returns
>=0 |
The size in bytes of the ignored filters list. |
< 0 |
An error occurred. Refer to Return Codes. |
Comments
In case the current ignored filters list should be changed, call this function before calling the LFileSettings::IgnoreFilters function.
To retrieve the ignored filters list, the user should do the following:
1. |
Call the LFileSettings::GetIgnoreFilters function passing pszFilters as NULL and uSize as 0 to retrieve the size required for the filters list as returned value. |
2. |
Allocate a buffer of size (Returned Value * sizeof(L_TCHAR)). |
3. |
Call the LFileSettings::GetIgnoreFilters function passing the allocated buffer to the pszFilters and the returned value to uSize to retrieve the filters list. |
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. |
Win32, x64.
See Also
Functions: |
LFileSettings::IgnoreFilters, LFileSettings::PreLoadFilters, LFileSettings::GetPreLoadFilters, Class Members. |
Topics: |
|
|
Example
#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName L_INT LFileSettings__GetIgnoreFiltersExample() { L_TCHAR * pszList = NULL; L_SIZE_T nRet; LFileSettings FileSettings; LBitmap Bitmap; /* get the original filters list */ nRet = LFileSettings::GetIgnoreFilters(NULL, 0); pszList = (L_TCHAR *)malloc(nRet*sizeof(L_TCHAR)); nRet = LFileSettings::GetIgnoreFilters(pszList, nRet); ::MessageBox(NULL, pszList, TEXT("TEST"), MB_OK); free(pszList); /* ignore TGA filter */ LFileSettings::IgnoreFilters(TEXT("TGA")); /* get the new filters list */ nRet = LFileSettings::GetIgnoreFilters(NULL, 0); pszList = (L_TCHAR *)malloc(nRet*sizeof(L_TCHAR)); nRet = LFileSettings::GetIgnoreFilters(pszList, nRet); ::MessageBox(NULL, pszList, TEXT("TEST"), MB_OK); free(pszList); /* try to load TGA, should fail: ERROR_FILE_FORMAT */ nRet = Bitmap.Load(MAKE_IMAGE_PATH(TEXT("test.tga"))); if(nRet == ERROR_FILE_FORMAT) ::MessageBox(NULL, TEXT("TGA ignored"), TEXT("TEST"), MB_OK); return SUCCESS; }