Foxit PDF SDK
FSDK.Progressive Class Reference

Public Member Functions

 Continue ()
 Continue the progressive process. More...
 
 GetRateOfProgress ()
 Get the rate of current progress. More...
 

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.
 

Member Function Documentation

◆ Continue()

FSDK.Progressive.Continue ( )

Continue the progressive process.

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

◆ GetRateOfProgress()

FSDK.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

FSDK.Progressive.e_Error
static

Enumeration for progress state.

Values of this enumeration should be used alone.

Progress state: any error occurs.