IImage::PushIntoSink

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

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