TFilterConfigurationIterator Class Reference

#include <mw/http/tfilterconfigurationiter.h>

class TFilterConfigurationIterator
Public Member Functions
IMPORT_C TBoolAtEnd()
IMPORT_C TBoolAtStart()
IMPORT_C const TFilterInformationCurrentFilterInformation()
IMPORT_C TIntFindByDataType(const TDesC8 &)
IMPORT_C TIntFirst()
IMPORT_C TIntInstallCurrentFilter()
IMPORT_C TIntNext()
IMPORT_C TIntUninstallCurrentFilter()

Detailed Description

This class can only be created and destroyed by the session. It is supplied to the client, if the client wishes to configure the filter that are installed or install filters that must be installed explicitly. The API of the class allows the client to navigate, install, uninstall and query the filter list. The filters visible in this list are only the implicit and explicit filters declared as plugins. This iterator MUST be initialised using the First() method and the return error code checked before any other operations are called.

Member Function Documentation

AtEnd ( )

IMPORT_C TBoolAtEnd()
Intended Usage: This method indicates whether the current filter is the last filter in the list. This method will panic if the iterator has not been initialised using the First() method.
Pre-condition
The iterator has been initialised using the First() method

Returns: ETrue if the current filter is the last in the list

AtStart ( )

IMPORT_C TBoolAtStart()
Intended Usage: This method indicates whether the current filter is the first filter in the list. This method will panic if the iterator has not been initialised using the First() method.
Pre-condition
The iterator has been initialised using the First() method

Returns: ETrue if the current filter is the first in the list

CurrentFilterInformation ( )

IMPORT_C const TFilterInformationCurrentFilterInformation()const
Intended Usage: This method will return the information of the current filter. The information is provided in a TFilterInformation structure containing the following information: 1) Display name 2) Data type 3) Version 4) UID 5) Category 6) Install status This method will panic if the iterator has not been initialised using the First() method
Pre-condition
The iterator has been initialised using the First() method

See also: TFilterInformation

Returns: A struct containing the current filter information

FindByDataType ( const TDesC8 & )

IMPORT_C TIntFindByDataType(const TDesC8 &aDataType)
Intended Usage: This method find the first filter in the list that has a matching data type that is passed in. The method will set the current filter to the filter that matches the data type or if not found the current filter will not change. This method will always begin its search from the beginning of the list.
Pre-condition
Object is constructed
Post-condition
The current filter is set to the filter that matches the data type
ParameterDescription
aDataTypeAn 8-bit descriptor containing the data type to match the filter plug-in with

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

First ( )

IMPORT_C TIntFirst()
Intended Usage: This method sets the current filter to the first filter in the list. This method 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.
Pre-condition
Object is constructed
Post-condition
Current filter is set to the first filter in the list

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

InstallCurrentFilter ( )

IMPORT_C TIntInstallCurrentFilter()const
Intended Usage: This method will install the current filter. This method will panic if a current filter is not set.
Pre-condition
A current filter has been set and is not already installed
Post-condition
The filter is installed

Returns: 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 is the filter is not installed due to low memory, or any other system-wide error codes.

Next ( )

IMPORT_C TIntNext()
Intended Usage: This method sets the current filter to the next filter in the list.
Pre-condition
Object is constructed
Post-condition
Current filter is set to the next filter in the list

Returns: 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.

UninstallCurrentFilter ( )

IMPORT_C TIntUninstallCurrentFilter()const
Intended Usage: This method will uninstall the current filter. This method will panic if a current filter is not set.
Pre-condition
A current filter has been set and has already been installed
Post-condition
The filter is uninstalled

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