LFileSettings::IgnoreFilters

#include "ltwrappr.h"

static L_INT LFileSettings::IgnoreFilters(pszFilters)

L_TCHAR * pszFilters;

character string containing filters

Specifies which file filters LEADTOOLS should NEVER load, even if present.

Parameter

Description

pszFilters

Character string containing which filters should be ignored and therefore not loaded. pszFilters has the same format as in LFileSettings::PreLoadFilters .

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Use this function if you never want to load a particular file filter(s).

The files specified in LFileSettings::PreLoadFilters take priority over the files specified in LFileSettings::IgnoreFilters. This means that if the filter is present in pszFilters for both methods, then the filter will be loaded and will not be ignored.

Note that LFileSettings::IgnoreFilters has effect only if called prior to loading, saving or getting information about a file. In addition, LFileSettings::PreLoadFilters must be called before LFileSettings::IgnoreFilters for LFileSettings::IgnoreFilters to work properly. For more information, refer to Loading File Filters.

In case the current ignored filters list should be changed, call the LFileSettings::GetIgnoreFilters function before calling this function.

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.

See Also

Functions:

LFileSettings::PreLoadFilters, LFileSettings::GetIgnoreFilters, LFileSettings::GetPreLoadFilters, Class Members

Topics:

Raster Image Functions: Input/Output File Filters, Files To Be Included With Your Application

Example

L_INT LFileSettings__IgnoreFiltersExample() 
{ 
   L_INT nRet; 
   LFileSettings fileSettings; 
 
   //Ignore CMP filter 
   nRet = fileSettings.IgnoreFilters(TEXT("CMP")); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   //... 
 
   return SUCCESS; 
} 
Help Version 20.0.2019.9.23
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help