Class TEComResolverParams

class TEComResolverParams;

Description

Used to pass values to a Resolver to aid in the filtering of Interface Implementation plugins. These values are considered match characteristics used during resolution of these Interface Implementation. It is a class used in the ECOM API provided by the REComSession class. This class DOES NOT own the descriptor data iDataType points to and so it will not release the data on descruction. This is the responsibility of the user of this class.

Members

Defined in TEComResolverParams:
DataType(), IsGenericMatch(), IsWildcardMatch(), SetDataType(), SetGenericMatch(), SetWildcardMatch(), TEComResolverParams()

See also:

• REComSession

inline TEComResolverParams();

Description

Default constructor of TEComResolverParams. It creates an empty uninitialized resolver parameter object. Such an object maybe used in calls to REComSession CreateImplementationL() and ListImplementationsL() methods when no specific matching or filtering is required i.e. default type matching will be used.

inline const TDesC8 &DataType() const;

Pre-Condition

The object is constructed

Description

Provides read access to the Interface Implementation plugin 'datatype' match pattern. Note, since TEComResolveParams has a default constructor this data member may be an invalid descriptor which implies 'default matching'.

Return value

const TDesC8 & The read only 'datatype' match pattern.

inline void SetDataType(const TDesC8 &aDataType);

Pre-Condition

The object is constructed

Description

Set the Interface Implementation plugin 'datatype' match pattern.

Post-Condition

iDataType equals aDataType.

Parameters

const TDesC8 &aDataType The 'datatype' match pattern to be stored.

inline TBool IsGenericMatch() const;

Pre-Condition

The object is constructed

Description

Check if 'generic' matching is allowed.

Return value

TBool ETrue if generic matching is allowed, EFalse otherwise.

inline void SetGenericMatch(TBool aGenericMatch);

Pre-Condition

The object is constructed

Description

Indicates that a 'generic' match is required.

Either allow Interface Implementation plugins that are specific (use no wildcards in their registry file) or generic (use wildcards in their registry file).

In any case the user of a should NOT use wildcards in the datatype string that is passed into this object.

Rationale: The client that sets up the resolver is expected to know what type of data it is handling.

Use Case: "I have this gif to convert, but I'd prefer only gif-specific plugins" or "I have this gif to convert, but I'm happy with some generic image conversion plugin".

NOT: "I have this image I want some plugin to convert, but I don't know the type of the image".

Post-Condition

iGenericMatch equals aGenericMatch.

Parameters

TBool aGenericMatch ETrue if a generic match is required, EFalse if not.

inline TBool IsWildcardMatch() const;

Description

Return value

TBool

inline void SetWildcardMatch(TBool aWildcardMatch);

Description

Parameters

TBool aWildcardMatch