SetFilter method

Specifies the URL to compare with each URL in the Windows Internet Explorer history.

Syntax

HRESULT retVal = object.SetFilter(poszFilter, dwFlags);

Parameters

  • poszFilter [in]
    Type: LPCOLESTR

    A match to a particular URL type.

  • dwFlags [in]
    Type: DWORD

    The IUrlHistory Flags that control how the STATURL structure is filled.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

IEnumSTATURL::SetFilter was introduced in Microsoft Internet Explorer 6.

IEnumSTATURL::Next compares the specified URL with each URL in the history to find matches, and then copies the list of matches to a buffer.

If a filter is specified in the poszFilter parameter, call IEnumSTATURL::Reset after the enumerator is no longer required.