Foxit PDF SDK
foxit::addon::optimization::Optimizer Class Reference
Inheritance diagram for foxit::addon::optimization::Optimizer:
foxit::Base

Static Public Member Functions

static common::Progressive Optimize (const pdf::PDFDoc &doc, const OptimizerSettings &settings, common::PauseCallback *pause)
 Optimize the given PDF document with specified optimizers settings. More...
 

Additional Inherited Members

- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

This class can be used to optimize PDF file to reduce file size. Before using this class to do optimization, please ensure Foxti PDF SDK has been initialized successfully by function common::Library::Initialize with a key including "Optimizer" module.

See also
common::Library

Member Function Documentation

◆ Optimize()

static common::Progressive foxit::addon::optimization::Optimizer::Optimize ( const pdf::PDFDoc doc,
const OptimizerSettings settings,
common::PauseCallback pause 
)
static

Optimize the given PDF document with specified optimizers settings.

Parameters
[in]docA valid PDF document object to be optimized.
[in]settingsSetting data used for optimization processing settings.
[in]pausePause object which decides if the process needs to be paused. This can be NULL which means not to pause during the optimization process. If this is not NULL, it should be a valid pause object implemented by user.
Note
If module "Optimizer" is not defined in the license information which is used in function common::Library::Initialize, that means user has no right in using Optimization related functions and this function will throw exception foxit::e_ErrNoOptimizerModuleRight.
Returns
A progressive object. Please check the rate of current progress by function common::Progressive::GetRateOfProgress. If the rate is not 100 yet, call function common::Progressive::Continue to coninue the progress until the progress is finished.