IImage::PushIntoSink (Compact 2013)

  • Article

3/26/2014

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

This method causes the underlying image object to push its data into an image sink.

Syntax

HRESULT PushIntoSink(
  IImageSink* sink
);

Parameters

  • sink
    [in] A pointer to the IImageSink interface that receives data from the image.

Return Value

If successful, this method returns S_OK.

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

  • IMGERR_ABORT
  • IMGERR_CODECNOTFOUND
  • IMGERR_OBJECTBUSY
  • E_FAIL
  • E_OUTOFMEMORY
  • E_UNEXPECTED

It can also return errors passed up from internal calls to IImageSink::PushPixelData, IImageSink::BeginSink, and IImageSink::SetPalette.

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

Requirements

Header

imaging.h

Library

Imaging.lib

See Also

Reference

IImage
IImageSink
IImageSink::PushPixelData
IImageSink::BeginSink
IImageSink::SetPalette