IEnumPins Interface
A version of this page is also available for
4/8/2010
The IBaseFilter::EnumPins method returns this interface. It is based on the IEnumX protocol of the Component Object Model (COM).
Note
Actions that cause the number of pins to change might cause the enumerator to fail.
When to Implement
This interface must be implemented and made available by the IBaseFilter::EnumPins method. The CBaseFilter::EnumPins member function automatically does this in the DirectShow class library and uses the CEnumPins class to create the enumerator object.
When to Use
This interface is normally used by the filter graph manager when connecting filters. It can, however, be used by an application that must find the pins associated with filters in the filter graph — for example, to add another filter to the graph.
Methods in Vtable Order
The following table shows the methods that appear in the Vtable beneath the standard COM methods inherited from IUnknown.
| Method | Description |
|---|---|
Puts pointers to IPin interfaces for the next pins into the specified array. |
|
Skips the specified number of pins. |
|
Resets the position to the beginning so that the next call to the IEnumPins::Next method returns, at a minimum, the first pin of the filter. |
|
Provides another enumerator, which is a duplicate of the current one. |
Requirements
| Windows Embedded CE | Windows CE 2.12 and later |
| Windows Mobile | Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later |
| Note | Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements For more information, see Setting Up the Build Environment |