ID_ProgressFunc function

Application supplied progress callback function.

Syntax

typedef int(__stdcall *ID_ProgressFunc)
(
   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 decoding. If zero is returned, then the plug-in should abort the decode process and return IDE_Cancelled.

Remarks

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

Requirements

Header: ID_PlugIn.h

See also:

• IDE_Cancelled
• ID_DecodeParam