FSCRT_PAUSEHANDLER Struct Reference

Structure for pause control in progressive process. More...

#include <fs_base_r.h>

Public Attributes

FS_LPVOID clientData
 User-defined data. More...
 
FS_BOOL(* NeedPauseNow )(FS_LPVOID clientData)
 A callback function to indicates whether current running can be broken or not. More...
 

Detailed Description

Structure for pause control in progressive process.

Note
This is a handler and is implemented by applications.
if a process takes a long time, Foxit PDF SDK uses a progressive mechanism to release CPU control to applications.
The function FSCRT_Progress_Continue uses this handler to release the current CPU control.

Member Data Documentation

FS_LPVOID FSCRT_PAUSEHANDLER::clientData

User-defined data.

Note
Applications can use this field to track controls.
FS_BOOL(* FSCRT_PAUSEHANDLER::NeedPauseNow) (FS_LPVOID clientData)

A callback function to indicates whether current running can be broken or not.

Parameters
[in]clientDataPointer to user-defined data.
Returns
TRUE means the current functions can be paused, or FALSE means not.
Note
Usually, applications can use a timer to determine how long the current function can run.

The documentation for this struct was generated from the following file:

Foxit Corporation