IRegFilterInfo Interface

The IRegFilterInfo interface provides access to filters in the registry and allows a registered filter to be added to the filter graph.

When to Implement

IRegFilterInfo is implemented by the filter graph manager for use by Automation client applications, such as Microsoft® Visual Basic®.

When to Use

Use this interface when it is exposed by an Automation client to query the names of filters in a collection of registry filters, and to add specific filters to the filter graph. A collection of IRegFilterInfo interfaces is returned by the IMediaControl::get_RegFilterCollection method.

Methods in Vtable Order

IUnknown methods	Description
QueryInterface	Returns pointers to supported interfaces.
AddRef	Increments the reference count.
Release	Decrements the reference count.

IDispatch methods	Description
GetTypeInfoCount	Determines whether there is type information available for this dispinterface.
GetTypeInfo	Retrieves the type information for this dispinterface if GetTypeInfoCount returned successfully.
GetIDsOfNames	Converts text names of properties and methods (including arguments) to their corresponding DISPIDs.
Invoke	Calls a method or accesses a property in this dispinterface if given a DISPID and any other necessary parameters.

IRegFilterInfo methods	Description
get_Name	Retrieves the name of the filter.
Filter	Creates an instance of this filter and adds it to the filter graph.

---

IRegFilterInfo::Filter

IRegFilterInfo Interface

Creates an instance of this filter and adds it to the filter graph.

HRESULT Filter(
  IDispatch **ppUnk
  );

Parameters

ppUnk

[out] IFilterInfo interface for the added filter.

Return Values

Returns an HRESULT value.

Remarks

Use the IRegFilterInfo::get_Name method (Name property in Visual Basic) to find the filter by comparing names in a collection of IRegFilterInfo interfaces.

---

IRegFilterInfo::get_Name

IRegFilterInfo Interface

Retrieves the name of the filter.

HRESULT get_Name(
  BSTR * strName
  );

Parameters

strName

[out, retval] Name of the filter.

Return Values

Returns an HRESULT value.

Remarks

Typically, a Visual Basic application will use the For Each...Next syntax on a collection of IRegFilterInfo interfaces and check the name of each filter in the registry until it finds the one it wants to add. It can then add the filter to the filter graph by using the IRegFilterInfo::Filter method.

© 1998 Microsoft Corporation. All rights reserved. Terms of Use.

Top of Page