IAMCollection Interface

The filter graph manager exposes IAMCollection, which allows access to collections of objects such as those exporting IPinInfo and IFilterInfo interfaces.

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

Applications that use Automation use this interface indirectly when retrieving collections of objects. For example, the IFilterInfo::get_Pins method retrieves an IAMCollection interface that can be used to access the IPinInfo interfaces corresponding to the pins on the filter.

Methods in Vtable Order

IUnknown methodsDescription
QueryInterface Retrieves pointers to supported interfaces.
AddRef Increments the reference count.
Release Decrements the reference count.
IDispatch methodsDescription
GetTypeInfoCount Determines whether there is type information available for this dispatch interface.
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.
IAMCollection methodsDescription
get_Count Retrieves the number of items in the collection.
get_NewEnum Retrieves an enumerator object that implements IEnumVARIANT on this collection.
Item Retrieves the indexed item from the collection.

IAMCollection::get_Count

IAMCollection Interface

Retrieves the number of items in the collection.

Syntax

HRESULT get_Count(
    LONG *plCount
    );

Parameters

plCount
[out, retval] Pointer to the number of items in the collection.

Return Value

Returns an HRESULT value.

IAMCollection::get_NewEnum

IAMCollection Interface

Retrieves an enumerator object that implements IEnumVARIANT on this collection.

Syntax

HRESULT get_NewEnum(
    IUnknown **ppUnk
    );

Parameters

ppUnk
[out, retval] Address of a pointer to an IUnknown interface for an object that implements IEnumVARIANT on this collection.

Return Value

Returns an HRESULT value.

IAMCollection::Item

IAMCollection Interface

Retrieves the indexed item from the collection.

Syntax

HRESULT Item(
    long lItem,
    IUnknown **ppUnk
    );

Parameters

lItem
[in] Index into the collection.
ppUnk
[out] Address of a pointer to the returned IUnknown interface for the contained item.

Return Value

Returns an HRESULT value.

Remarks

The returned ppUnk parameter represents an object corresponding to the type of objects in the container. It can be an IFilterInfo, IPinInfo, or IMediaTypeInfo object. The index is zero-based.


Top of Page Top of Page
© 2000 Microsoft and/or its suppliers. All rights reserved. Terms of Use.