Share via

IImageEncoder::SetFrameDimension (Compact 2013)

  • Article

3/26/2014

This feature is being deprecated for this release. Refer to this component: Windows Imaging Component.

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.

Code Example

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

Header

imaging.h

Library

Imaging.lib

See Also

Reference

IImageEncoder
Imaging GUIDs