Struct TFilterInformation

struct TFilterInformation;

Description

This structure is used by the TFilterConfigurationIterator to hold the information of the current filter. This structure simply contains public members containing the following information, the display name, data type, version, UID, category and install status.

Members

Defined in TFilterInformation:

• EExplicitFilter
• EImplicitFilter
• TFilterCategoryPublic enum defining the filter categories available to the client.
• TFilterInformation(const TDesC &,const TDesC8 &,TInt,TUid,TFilterCategory,TBool)Default constructor that simply initialises the data members.
• iDataTypeContains a constant reference to the descriptor containing the filter's data typ...
• iDisplayNameContains a constant reference to the descriptor containing the filter's display ...
• iFilterCategoryThe filter's category
• iFilterUidThe filter's plugin UID
• iInstallStatusThe install status of the filter. Contains ETrue if installed, otherwise EFalse
• iVersionThe filter's version number

See also:

• TFilterConfigurationIteratorThis class can only be created and destroyed by the session. It is supplied to t...

inline TFilterInformation(const TDesC &aDisplayName, const TDesC8 &aDataType, TInt aVersion, TUid aFilterUid, TFilterCategory aFilterCategory, TBool aInstallStatus);

Pre-Condition

None

Description

Default constructor that simply initialises the data members.

Post-Condition

Object is fully constructed and initialised

Parameters

const TDesC16 &aDisplayName Reference to descriptor containing the display name const TDesC8 &aDataType Reference to descriptor containing the data type TInt aVersion Integer of the version number TUid aFilterUid The UID of the filter plugin TFilterInformation::TFilterCategory aFilterCategory The category of the filter TBool aInstallStatus The install status of the filter plugin. Contains ETrue if installed or EFalse otherwise.

TFilterCategory

Description

Public enum defining the filter categories available to the client.

EImplicitFilter EExplicitFilter

const TDesC & iDisplayName;

Description

Contains a constant reference to the descriptor containing the filter's display name

const TDesC8 & iDataType;

Description

Contains a constant reference to the descriptor containing the filter's data type

TInt iVersion;

Description

The filter's version number

TUid iFilterUid;

Description

The filter's plugin UID

TFilterCategory iFilterCategory;

Description

The filter's category

TBool iInstallStatus;

Description

The install status of the filter. Contains ETrue if installed, otherwise EFalse