Share via

IBaseFilter::JoinFilterGraph

  • Article

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

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 Values

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 the filter from ever being correctly released. The filter graph manager does hold 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 any such 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

DirectShow applications and DirectShow filters have different include file and link library requirements. See Setting Up the Build Environment for more information.

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header:

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.