IE_ImageEncodePage function

Function that appends or replaces a page in the image file.

Syntax

PLUGIN_API int __stdcall IE_ImageEncodePage
(
   IE_StateHdl hState,
   int iPage,
   IE_EncodeParams* pEP,
   IE_PageInfo* pPI,
   IE_CallbackData* pCD
);

Parameters

hState

Type: IE_StateHdl

[in] Image state handle; hState is set by the host application to the same value that was passed to it by the plug-in during the relevant call to IE_ImageEncodeStart.

iPage

Type: int

[in] Destination page number (0-based)

pEP

Type: IE_EncodeParams*

[in] Encoding parameters for this page

pPI

Type: IE_PageInfo*

[in] Page data to be written

pCD

Type: IE_CallbackData*

[in] Progress callback data

Return Value

For a description of return values, see Return Values.

Remarks

If the encoding mode is IE_MODE_CREATENEW, then iPage must be set to the number of pages already written to the image, (i.e. the index of the last page written, plus one). Pages may only be appended sequentially in IE_MODE_CREATENEW mode.

If the encoding mode is IE_MODE_EDITEXISTING, then iPage must be between 0 and the number of pages currently in the image. If iPage refers to an existing page (0<=iPage<nPages), then the specified page is replaced by the specified page. If iPage refers to a non-existing page (iPage==nPages), then the page is appended to the image.

Requirements

Header: IE_PlugIn.h

See also: