
DEVELOPER LIBRARY

» Developer Library » API Reference » C++ API reference » HTTP Client » TFilterConfigurationIterator

Location: http\TFilterConfigurationIter.h
Link against: http.lib

Class `TFilterConfigurationIterator`

class TFilterConfigurationIterator

Support

Supported from 7.0

Description

Allows a client to navigate, install, uninstall and query the filter list.

The filters that are visible in this list are only the implicit and explicit filters declared as plugins.

The iterator must be initialised using First() and the returned error code checked before any other operations are called.

Objects of this class are created by the session: see MHTTPFilterCreationCallback::ConfigureSessionFiltersL().

Defined in TFilterConfigurationIterator:
AtEnd(), AtStart(), CurrentFilterInformation(), FindByDataType(), First(), InstallCurrentFilter(), Next(), TFilterConfigurationIterator(), UninstallCurrentFilter(), iCurrentFilterIndex, iFilterCount, iFilterInfoList, iSession, ~TFilterConfigurationIterator()

Member Functions

`First()`

TInt First();

Description

Sets the current filter to the first filter in the list.

This function must be used initially to set the current filter and the returned error code must be noted prior to using any of the methods that query or modify the current filter.

Return value


TInt

KErrNone if the first filter is found, or KErrNotFound if the filter can't be found or no filters exist

`Next()`

TInt Next();

Description

Sets the current filter to the next filter in the list.

Return value


TInt

KErrNone if the next filter is found, KErrNotFound if the filter can't be found, or no filters exist, or the current filter is at the end of the list

`AtStart()`

TBool AtStart();

Description

Tests if the current filter is the first filter in the list.

The function panics if the iterator has not been initialised using First().

Return value


TBool

ETrue if the current filter is the first in the list

`AtEnd()`

TBool AtEnd();

Description

Tests if the current filter is the last filter in the list.

The function panics if the iterator has not been initialised using First().

Return value


TBool

ETrue if the current filter is the last in the list

`FindByDataType()`

TInt FindByDataType(const TDesC8& aDataType);

Description

Finds the first filter in the list for a specified data type.

The function sets the current filter to the filter that matches the data type, or if not found, the current filter does not change. This function always begins its search from the beginning of the list.

Parameters

const TDesC8& aDataType

An 8-bit descriptor containing the data type to match the filter plug-in with

Return value


TInt

KErrNone if the filter plug-in is found, KErrNotFound if not found

`CurrentFilterInformation()`

const TFilterInformation CurrentFilterInformation() const;

Description

Gets information about the current filter.

The information returned contains the display name, data type, version, UID, category and install status.

The function panics if the iterator has not been initialised using First().

Return value

const
TFilterInformation

A struct containing the current filter information

`InstallCurrentFilter()`

TInt InstallCurrentFilter() const;

Description

Installs the current filter.

This function will panic if a current filter is not set.

Return value


TInt

KErrNone if the filter installed, KErrAlreadyExists if the filter has already been installed, KErrNotFound if the filter cannot be found, KErrNotConnected if the ECom plug-in architecture is not connected, KErrNoMemory if the filter is not installed due to low memory, or any other system-wide error codes

`UninstallCurrentFilter()`

TInt UninstallCurrentFilter() const;

Description

Uninstalls the current filter.

This function panics if a current filter is not set.

Return value


TInt

KErrNone if the filter uninstalled correctly, KErrNotFound if the filter has not already been installed