In This Topic ▼

LFileSettings::SetJBIG2Options

#include "ltwrappr.h"

static L_INT LFileSettings::SetJBIG2Options(pOptions)

Sets the file options used by LEADTOOLS for saving JBIG2 files.

Parameters

pFILEJBIG2OPTIONS pOptions

Pointer to the FILEJBIG2OPTIONS structure that contains the options to be used for saving JBIG2 files.

Returns

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

Comments

The uStructSize member of the FILEJBIG2OPTIONS structure must be set before calling this function.

The values set by this function are valid for the current thread. To change the values used by the current thread, this function must be called again.

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.

Example

This example will make it so the next time you save a JBIG2 file, it will be saved with Template #3.

L_INT LFileSettings__SetJBIG2OptionsExample() 
{ 
   L_INT nRet = FAILURE; 
   FILEJBIG2OPTIONS JBIG2Options;  
 
   // get the current values. I only want to change the template  
   nRet = LFileSettings::GetJBIG2Options ( &JBIG2Options, sizeof(FILEJBIG2OPTIONS));  
   if(nRet != SUCCESS) 
      return nRet; 
 
   // set the Image template value to 3 
   JBIG2Options.ucImageTemplateType = 3;  
 
   JBIG2Options.ucTextTemplateType = 3; 
 
   // set the compression options. The next time a  
   // JBIG2 file is saved, it will be saved with template # 3  
   nRet = LFileSettings::SetJBIG2Options(&JBIG2Options); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}