ICaptureGraphBuilder2::GetFiltergraph method (strmif.h)

[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 GetFiltergraph method retrieves the filter graph that the capture graph builder is using.

Syntax

HRESULT GetFiltergraph(
  [out] IGraphBuilder **ppfg
);

Parameters

[out] ppfg

Receives an IGraphBuilder interface pointer.

Return value

Returns one of the following HRESULT values.

Return code	Description
S_OK	Success.
E_POINTER	NULL pointer argument.
E_UNEXPECTED	No filter graph.

Remarks

Initially, the capture graph builder does not hold a pointer to a filter graph. This method returns E_UNEXPECTED until one of the following methods has been called:

• ICaptureGraphBuilder2::RenderStream
• ICaptureGraphBuilder2::SetFiltergraph
• ICaptureGraphBuilder2::SetOutputFileName

This method increments the reference count on the IGraphBuilder interface. Be sure to release the interface when you are done with it.

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

ICaptureGraphBuilder2 Interface