Edit

IMemInputPin::ReceiveCanBlock method (strmif.h)

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The ReceiveCanBlock method determines whether calls to the IMemInputPin::Receive method might block.

Syntax

HRESULT ReceiveCanBlock();

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return code Description
S_FALSE
 The pin will not block on a call to Receive
S_OK
 The pin might block on a call to Receive.

Remarks

If this method returns S_FALSE, calls to the Receive method are guaranteed not to block. Otherwise, they might block. An upstream filter can use this method to determine its threading strategy. If calls to Receive can block, the upstream filter might decide to use a worker thread that buffers data.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IMemInputPin Interface