CX_WriteImage function

Callback function that encodes a DIB (Device Independent Bitmap) into an image file with the specified format and encoding parameters.

Syntax

typedef int(__stdcall *PF_CX_WriteImage) 
(
   BITMAPINFO* pBMI,
   void* pBits,
   DWORD dwFormatId,
   IE_EncodeParams* pep,
   const wchar_t* pszOutputFN,
   int (__stdcall*Callback)(void* pParam, int nNum, int nDen),
   void* pParamCB
);

Parameters

pBMI

Type: BITMAPINFO*

[in] BITMAPINFO of the bitmap to write.

pBits

Type: void*

[in] bits of the bitmap to write.

dwFormatId

Type: DWORD

[in] format ID of the image format of the output image (made with MAKE_FORMATID).

pep

Type: IE_EncodeParams*

[in] encoding parameters. These can be retrieved using CX_GetDefaultEncodeParams or CX_EncodeParamsDlg.

pdzOutputFN

Type: const wchar_t*

output image path.

int ( __stdcall* Callback ) ( void* pParam, int nNum, int nDen )

Type: int ( __stdcall* Callback ) ( void* pParam, int nNum, int nDen )

[in] callback function to display encoding status.

pParamCB

Type: void*

[in] parameter passed to the callback function

Return Value

For a description of return values, see Return Values.

Remarks

This is a callback function that the plug-in can use to encode a DIB (Device Independent Bitmap) into an image file with the specified format and encoding parameters. It is worth noting that this function returns an IEP status code, instead of a CXP status code.

Requirements

Header: CX_PlugIn.h

See also: