Filters Object

This object represents a collection of filters that are available for use by the folder comparison window when determining which files and folders to include in the folder comparison. The first filter in the collection is always the active filter, with the rest being available for selection or viewing in the Filters page of the Options dialog.

Properties

Countread-onlyIFilters

The number of filters in the collection. There is always at least one filter.

IDL [propget] HRESULT Count([out, retval] long* pValue)
.NET Int32 Count[get]
VB6 Count As Long

Itemread-onlyIFilters

Used to obtain a copy of a filter in the filters collection.

IDL [propget] HRESULT Item(
    [in] VARIANT index,
    [out, retval] IFilter** pValue)
.NET Filter get_Item(
    Object index)
VB6 Item(
    index As Variant) As Filter
  • index
    An integer index into the collection, or the name of a filter.

Methods

MakeActiveIFilters

Makes the filter at the specified index the active filter. The filter is moved to the start of the filters collection.

IDL HRESULT MakeActive(
    [in] long index)
.NET void MakeActive(
    Int32 index)
VB6 MakeActive(
    index As Long)
  • index
    Specifies the index of the filter that is to be made active.

RemoveIFilters

Removes the filter at the specified index. If the last filter in the collection is removed, a simple default filter matching everything is automatically added to the filters collection.

IDL HRESULT Remove(
    [in] long index)
.NET void Remove(
    Int32 index)
VB6 Remove(
    index As Long)
  • index
    Specifies the index of the filter that is to be removed.

StoreIFilters

Stores a copy of a filter in the filters collection. The method returns the filter’s index within the collection.

IDL HRESULT Store(
    [in] IFilter* filter,
    [out, retval] long* pValue)
.NET Int32 Store(
    Filter filter)
VB6 Store(
    filter As Filter) As Long
  • filter
    Specifies the filter that is to be stored within the filters collection.