IFilterGraph::AddFilter method

The AddFilter method adds a filter to the graph.

Syntax


HRESULT AddFilter(
  [in]  IBaseFilter *pFilter,
  [in]  LPCWSTR pName
);

Parameters

pFilter [in]

Pointer to the IBaseFilter interface of the filter to add.

pName [in]

Pointer to a wide-character string containing a name for filter.

Return value

Returns an HRESULT value. Possible values include the following.

Return codeDescription
S_OK

Success.

VFW_S_DUPLICATE_NAME

Successfully added a filter with a duplicate name.

E_FAIL

Failure.

E_OUTOFMEMORY

Insufficient memory.

E_POINTER

NULL pointer argument.

VFW_E_CERTIFICATION_FAILURE

Use of this filter is restricted by a software key.

VFW_E_DUPLICATE_NAME

Failed to add a filter with a duplicate name.

 

Remarks

The name of the filter can be NULL, in which case the Filter Graph Manager generates a name. If the name is not NULL and is not unique, this method will modify the name in an attempt to generate a new unique name. If this is successful, this method returns VFW_S_DUPLICATE_NAME. If it cannot generate a unique name, it returns VFW_E_DUPLICATE_NAME.

AddFilter calls the filter's IBaseFilter::JoinFilterGraph method to inform the filter that it has been added. AddFilter must be called before attempting to use the IGraphBuilder::Connect, IFilterGraph::ConnectDirect, or IGraphBuilder::Render method to connect or render pins belonging to the added filter.

The Filter Graph Manager holds a reference count on the filter until the filter is removed from the graph or the Filter Graph Manager is released.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IFilterGraph Interface

 

 

Community Additions

ADD
Show:
© 2014 Microsoft