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

Passes in a single sample to send to the input pin.

Syntax 

HRESULT Receive(
  IMediaSample* 
pSample 
);

Parameters

pSample

Pointer to the sample to be passed to the connected input pin.

Return Value

Returns an HRESULTvalue, which can include the following values, or others.

Value Description

S_FALSE

End of stream detected before or while processing sample; any further samples will be discarded and this value returned.

Other

An error occurred before or while processing sample; any further samples will be discarded and this value returned.

S_OK

Queued successfully or passed to the connected input pin if there is no queue.

Remarks

If the sticky return code ( m_hr) is not S_OK, the sample is not sent and the sticky return code is returned. (A sticky return code is one that persists even after operations that would usually change its value.)

The samples are all released (by means of Release) after processing, regardless of whether the processing was successful.

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