IE_Progress function

Application supplied progress callback function.

Syntax

typedef int (WINAPI *PF_IE_Progress)
(
   void* pParam,
   int   nProgressNum,
   int   nProgressDen
);

Parameters

pParam

Type: void*

[in] Progress context.

nProgressNum

Type: int

[in] Numerator of the fraction that represents the progress.

nProgressDen

Type: int

[in] Denominator of the fraction that represents the progress.

Return Value

The application returns a non-zero value to continue encoding. If zero is returned, then the plug-in should abort the encode process and return IEE_Cancelled.

Remarks

This function should be called by the plug-in periodically during image encoding. The encoding progress is indicated by (nProgressNum/nProgressDen), which will vary over the decoding process, starting with 0 and ending with 1 (nProgressNum==nProgressDen).

Requirements

Header: IE_PlugIn.h