IBaseFilter::JoinFilterGraph (Compact 2013)

  • Article

3/26/2014

This method notifies a filter that it has joined a filter graph.

Syntax

HRESULT JoinFilterGraph(
  IFilterGraph* pGraph,
  LPCWSTR pName
);

Parameters

  • pGraph
    [in] Pointer to the filter graph to join.
  • pName
    [in, string] Name of the filter being added.

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

The filter should store this interface for later use because it might need to notify the interface about events.

The filter should not add a reference count to this interface. Doing so causes circular references and prevents the graph or filter from being correctly released.

The filter graph manager holds a reference on the filter.

The filter does not need to hold a reference to ensure that the interface does not disappear; it is notified of a disappearance by a further call to IBaseFilter::JoinFilterGraph, with a null value for the pGraph parameter to indicate that the filter is no longer part of the graph.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IBaseFilter Interface