PFNProgressNotification callback function (wincodec.h)
Application defined callback function called when codec component progress is made.
Syntax
PFNProgressNotification Pfnprogressnotification;
HRESULT Pfnprogressnotification(
LPVOID pvData,
ULONG uFrameNum,
WICProgressOperation operation,
double dblProgress
)
{...}
Parameters
pvData
Type: LPVOID
Component data passed to the callback function.
uFrameNum
Type: ULONG
The current frame number.
operation
Type: WICProgressOperation
The current operation the component is in.
dblProgress
Type: double
The progress value. The range is 0.0 to 1.0.
Return value
Type: HRESULT
If this callback function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
An operation can be canceled by returning WINCODEC_ERR_ABORTED.
To register your callback function, query the encoder or decoder for the IWICBitmapCodecProgressNotification interface and call RegisterProgressNotification.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP with SP2, Windows Vista [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2008 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | wincodec.h |
See also
Reference