IE_GetDefaultEncodeParams function

Function to retrieve the default settings that should be used to encode a specified image format.

Syntax

PLUGIN_API int __stdcall IE_GetDefaultEncodeParams
(
   DWORD             dwFormatID,
   int*              pcbEncodeParams,
   IE_EncodeParams*  pEncodeParams
); 

Parameters

dwFormatID

Type: DWORD

[in] ID of format to get encoding parameters for

pcbEncodeParams

Type: int*

[i/o] Size of encoding parameters

pEncodeParams

Type: IE_EncodeParams*

[out] Receives default encoding parameters

Return Value

For a description of return values, see Return Values.

Remarks

This function initializes the encoding parameters structure for the specified format to default values. Upon entry, pcbEncodeParams gives the size of pEncodeParams.

The plug-in should handle the following cases:

• pcbEncodeParams too small: Set pcbEncodeParams to the correct size and return IEE_StructSize.
• pEncodeParams is NULL: Set pcbEncodeParams to the correct size and return IEE_InvalidParam.
• pcbEncodeParams is large enough and pEncodeParams is not NULL: Initialize pEncodeParams to default values.

Requirements

Header: IE_PlugIn.h

See also:

• IEE_InvalidParam
• IEE_StructSize
• IE_EncodeParams
• Return Values