IImageEncoder::SetFrameDimension

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method is used to set the active frame dimension when encoding a multiframe image.

Syntax

HRESULT SetFrameDimension(
  const GUID* dimensionID
);

Parameters

• dimensionID
  [in] A pointer to a GUID specifying the dimension for the frame.

  Set this value to a multiframe dimension identifier. For more information, see Imaging GUIDs.

Return Value

If successful, this method returns S_OK.

This method may return E_FAIL if it fails.

Remarks

The following pseudo code shows how an application might encode a multiframe image.

encoder->SetFrameDimension(FRAMEDIM_PAGE);
encode page 1
encoder->SetFrameDimension(FRAMEDIM_RESOLUTION)
encode page 2.1
encode page 2.2
encoder->SetFrameDimension(FRAMEDIM_PAGE);
encode page 3

Requirements

See Also

Reference

IImageEncoder
Imaging GUIDs