IMemInputPin::Receive
A version of this page is also available for
4/8/2010
This method receives the next block of data from the stream.
Syntax
HRESULT Receive(
IMediaSample* pSample
);
Parameters
- pSample
[in] Pointer to a media sample.
Return Value
Returns an HRESULT value that depends on the implementation.
HRESULT can be one of the following standard constants, or other values not listed.
Value | Description |
---|---|
E_FAIL |
Failure. |
E_POINTER |
Null pointer argument. |
E_INVALIDARG |
Invalid argument. |
E_NOTIMPL |
Method is not supported. |
S_OK or NOERROR |
Success. |
Remarks
This is a blocking synchronous call.
Typically, no blocking occurs, but if a filter cannot process the sample immediately it may use the calling application's thread to wait until it can.
Use the IUnknown::AddRef method if you need to hold the returned data block beyond the completion of the IMemInputPin::Receive method.
If you use AddRef, be sure to use IUnknown::Release when done with it.
Requirements
Windows Embedded CE | Windows CE 2.12 and later |
Windows Mobile | Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for 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 |