LBaseFile::GetFilterListInfo

#include "ltwrappr.h"

static L_INT LBaseFile::GetFilterListInfo(ppFilterList, pFilterCount)

pFILTERINFO * ppFilterList;	pointer to a pointer to a FILTERINFO structure
L_UINT * pFilterCount;	pointer to a variable to be updated

Retrieves an array of information for all filters.

Parameter	Description
ppFilterList	Pointer to a pointer to a FILTERINFO structure that represents an array of information for all filters. The address of this structure will be stored into *ppFilterList. This parameter cannot be NULL.
pFilterCount	Pointer to a variable to be updated with the number of elements of ppFilterList array.

Returns

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

Comments

The function will allocate a FILTERINFO structure large enough to contain the information of all filters.

When the array ppFilterList is no longer needed, the user is responsible to free this structure by calling the LBaseFile::FreeFilterInfo(*ppFilterList, *pFilterCount, FILTERINFO_FREEALL) function

To obtain the information for a specific filter, call the LBaseFile::GetFilterInfo function.

To update the information of a specific filter, call LBaseFile::SetFilterInfo function.

To update the filter extension list, be sure to save and restore the original filter list before calling LBaseFile::FreeFilterInfo 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.

Example

L_INT LBaseFile__GetFilterListInfoExample() 
{ 
   pFILTERINFO pFilterList; 
   L_UINT uFilterCount; 
   L_TCHAR* pszOrigExtensionList; 
   L_INT nRet; 
   nRet = LBaseFile::GetFilterListInfo(&pFilterList, &uFilterCount); 
   if(nRet !=SUCCESS) 
      return nRet; 
   // Save the original extension list so you can free it later 
   pszOrigExtensionList = pFilterList[2].pszExtensionList; 
   //Designate files with extension abc or cba as type 2 
   pFilterList[2].pszExtensionList = L_TEXT("abc,cba"); 
   // Remove the FILTERINFO_CHECKEDBYFILEINFO flag. This will make the 
   // LFile::GetInfo function checks for this filter only if the extension is in the extension list that have been set above 
   pFilterList[2].uFlags = pFilterList[2].uFlags & ~FILTERINFO_CHECKEDBYFILEINFO; 
   // Update the filter information. Note: This will affect all threads! 
   nRet =LBaseFile::SetFilterInfo(&pFilterList[2], 1, 0); 
   if(nRet !=SUCCESS) 
      return nRet; 
   // Restore the original extension list 
   pFilterList[2].pszExtensionList = pszOrigExtensionList; 
   // Free the pFilterList array that was allocated with LBaseFile::GetFilterListInfo 
   nRet =LBaseFile::FreeFilterInfo(pFilterList, uFilterCount, FILTERINFO_FREEALL); 
   if(nRet !=SUCCESS) 
      return nRet; 
}

Help Version 19.0.2017.10.27

Products | Support | Contact Us | Copyright Notices
© 1991-2017 Apryse Sofware Corp. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help

Introduction

Version History

Getting Started

LEADTOOLS Raster Imaging Features

Redistributables/Files To Be Included With Your Application

Quick Reference

Tutorials

Classes and Member Functions

Call Back Functions

Summary of Features

Functions:	LBaseFile::GetFilterInfo, LBaseFile::FreeFilterInfo, LBaseFile::SetFilterInfo, LFile::GetInfo
Topics:	Raster Image Functions: Loading Files
	Raster Image Functions: Getting and Setting File Information
	Loading and Saving Images