Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method is used to start decoding the currently selected frame.

Syntax 

HRESULT BeginDecode(
  IImageSink*				 
sink,
  OPTIONAL IPropertySetStorage* 
newPropSet
);

Parameters

sink

[in] A pointer to an IImageSinkinterface that receives the image data that results from decoding the frame.

newPropSet

[in] An optional pointer to an IPropertySetStorageinterface that contains a property set. The decoder should attach this set to the decoded image when it calls IImageSink::PushPropertyItems, rather than the property set it derives from the decoded image.

Return Value

If successful, this method returns S_OK.

If it fails, this method should return one of the following error values:

  • E_NOTIMPL

  • E_POINTER

  • E_UNEXPECTED

For more information, see Error Codes for the Imaging API.

Requirements

Header imaging.h
Library Imaging.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also