IWICJpegFrameEncode::WriteScan method (wincodec.h)

Article
02/22/2024

Writes scan data to a JPEG frame.

Syntax

HRESULT WriteScan(
  UINT       cbScanData,
  const BYTE *pbScanData
);

Parameters

cbScanData

Type: UINT

The size of the data in the pbScanData parameter.

pbScanData

Type: BYTE*

The scan data to write.

Return value

Type: HRESULT

Returns S_OK on successful completion.

Remarks

WriteScan may be called multiple times. Each call appends the scan data specified to any previous scan data. Complete the scan by calling IWICBitmapFrameEncode::Commit.

Any calls to set encoder parameters or image metadata that will appear before the scan data in the resulting JPEG file must be completed before the first call to this method. This includes calls to IWICBitmapFrameEncode::SetColorContexts , IWICBitmapFrameEncode::SetPalette, IWICBitmapFrameEncode::SetPixelFormat, IWICBitmapFrameEncode::SetResolution, and IWICBitmapFrameEncode::SetThumbnail. IWICBitmapFrameEncode::SetSize is required as it has no default value for encoded image size.

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	wincodec.h
Library	Windowscodecs.lib
DLL	Windowscodecs.dll