Foxit PDF RDK
Progressive Class Reference
Inheritance diagram for Progressive:
NativeObjectWrapper

Public Member Functions

 Continue ()
 Continue the progressive process. More...
 
 GetRateOfProgress ()
 Get the rate of current progress. More...
 
- Public Member Functions inherited from NativeObjectWrapper
 constructor (r)
 
 GetPointerAsNumber ()
 

Static Public Attributes

static e_Error
 Enumeration for progress state. More...
 
static e_Finished
 Progress state: progress is finished.
 
static e_ToBeContinued
 Progress state: progress needs to be continued.
 

Detailed Description

Member Function Documentation

◆ Continue()

Progressive.Continue ( )

Continue the progressive process.

Returns
Progressive.e_Finished means current process is finished successfully.
Progressive.e_ToBeContinued means current process is suspended, and this function needs to be called again to continue the process.
Progressive.e_Error means any error occurs.

◆ GetRateOfProgress()

Progressive.GetRateOfProgress ( )

Get the rate of current progress.

Returns
An integer between 0 and 100 (inclusive), indicating the rate of current progress. -1 means error.

Member Data Documentation

◆ e_Error

Progressive.e_Error
static

Enumeration for progress state.

Values of this enumeration should be used alone.

Progress state: any error occurs.