DirectShow Animated Header -- IFilterInfo Object DirectShow Animated Header -- IFilterInfo Object* Microsoft DirectShow SDK
*Index  *Topic Contents
*Previous Topic: IBasicVideo Object
*Next Topic: IMediaControl Object

IFilterInfo Object


IFilterInfo is an object that manages information about a filter and allows access to the filter object and IPinInfo object.

Properties
Name Description
Filename Retrieves or sets the file name associated with the source filter.
Filter Retrieves the actual filter object.
IsFileSource Indicates whether the filter is a file source filter.
Name Retrieves the filter name.
Pins Retrieves an IAMCollection object containing the IPinInfo objects for this filter.
VendorInfo Retrieves a string containing optional information supplied by a vendor about the specified filter.

Methods
Name Description
FindPin Locates a pin, given an identifier, and returns an object supporting IPinInfo.


Filename Property (IFilterInfo Object)

IFilterInfo Object

Retrieves or sets the name of the file containing the filter.

objFilterInfo.Filename [= string]

Parts
objFilterInfo
Object expression that evaluates to an IFilterInfo object.
string
String expression that specifies the new file name.


Filter Property (IFilterInfo Object)

IFilterInfo Object

Retrieves the filter object.

Set objFilter = objFilterInfo.Filter

Parts
objFilter
Object expression that evaluates to an IBaseFilter object.
objFilterInfo
Object expression that evaluates to an IFilterInfo object.
Remarks

No programmable object interface is offered for the IBaseFilter interface. However, Visual Basic® programmers can use the returned object as a parameter in calls to functions that take an IBaseFilter interface pointer as a parameter.


FindPin Method (IFilterInfo Object)

IFilterInfo Object

Locates a pin, given an identifier, and returns an IPinInfo object.

objFilterInfo.FindPin string, objPin

Parts
objFilterInfo
Object expression that evaluates to an IFilterInfo object.
string
String that contains the name of the pin to find.
objPin
IPinInfo object that will contain the specified pin, if the pin exists.
Remarks

No programmable object interface is offered for the IPin interface. However, Visual Basic programmers can use the returned object as a parameter in calls to functions that take the IPin interface pointer as a parameter.


IsFileSource Property (IFilterInfo Object)

IFilterInfo Object

Determines if the file contains the source video.

objFilterInfo.IsFileSource

Parts
objFilterInfo
Object expression that evaluates to an IFilterInfo object.
Return Values

The value True indicates that the file contains the source video. False indicates that the file does not contain the source video.


Name Property (IFilterInfo Object)

IFilterInfo Object

Retrieves the filter name.

objFilterInfo.Name

Parts
objFilterInfo
Object expression that evaluates to an IFilterInfo object.
Remarks

The vendor specifies the filter name.


Pins Property (IFilterInfo Object)

IFilterInfo Object

Retrieves an IAMCollection object containing the IPinInfo objects for this filter.

Set objPinCollection = objFilterInfo.Pins

Parts
objPinCollection
IAMCollection object that will contain the specific filter's pins.
objFilterInfo
IFilterInfo object that specifies the filter whose pins you want to retrieve.
Remarks

You can use the Count property and Item method to iterate through each of the pin objects in the collection.


VendorInfo Property (IFilterInfo Object)

IFilterInfo Object

Retrieves a string containing optional information supplied by a vendor about the specified filter.

objFilterInfo.VendorInfo

Parts
objFilterInfo
Object expression that evaluates to an IFilterInfo object.
Remarks

This property contains any information the vendor chooses to supply. It is usually descriptive information about the filter.

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

*Top of Page