Class CCnaConverterList

class CCnaConverterList : public CBase;

Description

Provides a list of available converters, allowing clients to search for and obtain converters for specific source and target data types.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CCnaConverterList - Provides a list of available converters, allowing clients to search for and obtain converters for specific source and target data types

Members

Defined in CCnaConverterList:
ConvFromL(), ConvFromListL(), ConvToL(), ConvToListL(), ConverterL(), Count(), CountL(), MimeTypeFrom(), MimeTypeTo(), NewConverterL(), NewL(), NewLC(), Release(), UpdateL(), ~CCnaConverterList()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also

• Using Converter

static IMPORT_C CCnaConverterList *NewL();

Description

Allocates and constructs a CCnaConverterList.

Return value

CCnaConverterList * New converter list

static IMPORT_C CCnaConverterList *NewLC();

Description

Allocates and constructs a CCnaConverterList, leaving the object on the cleanup stack.

Return value

CCnaConverterList * New converter list

IMPORT_C ~CCnaConverterList();

Description

Destructor.

This releases all loaded converter DLLs.

IMPORT_C void Release();

Description

Legacy function, do not use.

IMPORT_C TInt CountL();

Description

Gets the total number of converters.

It can leave because it needs to rescan the disk to refresh the list of converters.

Return value

TInt Total number of converters

inline TInt Count();

Description

Deprecated - Use CCnaConverterList::CountL instead. Rescan of the disk to refresh the list of converters could leave.

Return value

TInt

IMPORT_C CConverterBase *NewConverterL(TUid aUid);

Description

Locates the converter with the specified UID, loads its associated DLL and returns a pointer to it.

Parameters

TUid aUid Converter UID

Return value

CConverterBase * Converter with the specified UID, or NULL if there is no suitable converter

IMPORT_C void UpdateL();

Description

Requests a rescan of the disk to refresh the list of converters.

IMPORT_C TUid ConvFromL(const TDataType &aMimeType);

Description

Gets the UID of the converter that converts from the specified data type.

Parameters

const TDataType &aMimeType Source data type

Return value

TUid Converter UID

IMPORT_C TUid ConvToL(const TDataType &aMimeType);

Description

Gets the UID of the converter that converts to a specified data type.

Parameters

const TDataType &aMimeType Target data type

Return value

TUid Converter UID

IMPORT_C TUid ConverterL(const TDataType &aFrom, const TDataType &aTo);

Description

Gets the UID of the converter that converts to and from the specified data types.

Parameters

const TDataType &aFrom Source data type const TDataType &aTo Target data type

Return value

TUid Converter UID

IMPORT_C void ConvFromListL(const TDataType &aMimeType, CArrayFix< SConverterInfo > *aSConverterInfoArray);

Description

Gets a list of converters that convert from a specified data type.

Parameters

const TDataType &aMimeType Source data type CArrayFix< SConverterInfo > *aSConverterInfoArray On return, array of converter information objects for all suitable converters

IMPORT_C void ConvToListL(const TDataType &aMimeType, CArrayFix< SConverterInfo > *aSConverterInfoArray);

Description

Gets a list of converters that convert to a specified data type.

Parameters

const TDataType &aMimeType Target data type CArrayFix< SConverterInfo > *aSConverterInfoArray On return, an array of converter information objects for all suitable converters

IMPORT_C TInt MimeTypeFrom(TDataType &aDataType, const SConverterInfo &aConverterInfo) const;

Description

Gets converter information for a specified source data type.

Parameters

TDataType &aDataType Source data type const SConverterInfo &aConverterInfo On return, converter information for a suitable converter

Return value

TInt KErrNone if a suitable converter was found, else KErrNotFound

IMPORT_C TInt MimeTypeTo(TDataType &aDataType, const SConverterInfo &aConverterInfo) const;

Description

Gets converter information for a specified target data type.

Parameters

TDataType &aDataType Target data type const SConverterInfo &aConverterInfo On return, converter information for a suitable converter

Return value

TInt KErrNone if a suitable converter was found, else KErrNotFound