IE_ImageEncodeStart function

Function that begins writing to a new or existing image file.

Syntax

PLUGIN_API int __stdcall IE_ImageEncodeStart
(
   int iMode,
   IE_OutputInfo* pOI,
   IE_ImageInfo* pII,
   IE_StateHdl* phState
);

Parameters

iMode

Type: int

[in] Encoding mode: either IE_MODE_CREATENEW or IE_MODE_EDITEXISTING

pOI

Type: IE_OutputInfo*

[in] Output information

pII

Type: IE_ImageInfo*

[in] Image information

phState

Type: IE_StateHdl*

[out] Encoding state handle; phState will be passed to the plug-in during subsequent function calls, and is useful for keeping track of what state the plug-in was operating in when the current image was opened for encoding.

Return Value

For a description of return values, see Return Values.

Remarks

IE_MODE_EDITEXISTING is supported only when the FIF_EDITMODE flag is specified in IE_FormatInfo. If IE_MODE_CREATENEW is specified, and the output image exists, it will be overwritten. If IE_MODE_EDITEXISTING is specified, then the output image must exist, or an error occurs.

Requirements

Header: IE_PlugIn.h

See also: