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

Creates a memory copy of an image.

Syntax 

HRESULT CopyImage(
  IMediaSample* 
pMediaSample,
  VIDEOINFOHEADER* 
pVideoInfo,
  LONG* 
pBufferSize,
  BYTE* 
pVideoImage,
  RECT* 
pSourceRect
);

Parameters

pMediaSample

Sample containing the video image.

pVideoInfo

Format representing the video image.

pBufferSize

Size of the output buffer.

pVideoImage

Pointer to the output buffer.

pSourceRect

Source video rectangle.

Return Value

If the pVideoImageparameter is NULL, the pBufferSizeparameter is filled in with the number of bytes the output buffer requires to store the image.

If the buffer passed in is too small or the member function fails to allocate sufficient memory, the member function returns E_OUTOFMEMORY.

Remarks

The member function retrieves the image from the sample and copies it into the output buffer.

The section of video copied into the output buffer reflects the source rectangle that is set through the IBasicVideointerface (although it does not reflect the destination rectangle).

Requirements

Windows Embedded CE Windows CE 2.12 and later
Windows Mobile Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment,
Version 2.12 requires DXPAK 1.0 or later