Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: conlist.h
Link against: conarc.lib

Class CCnaConverterList

CCnaConverterList

Support

Supported from 6.0

Description

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

Derivation

CBaseBase class for all classes to be instantiated on the heap
CCnaConverterListProvides a list of available converters, allowing clients to search for and obtain converters for specific source and target data types

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

Inherited from CBase:
operator new()


Construction and destruction


NewL()

static CCnaConverterList* NewL();

Description

Allocates and constructs a CCnaConverterList.

Return value

CCnaConverterList*

New converter list


NewLC()

static CCnaConverterList* NewLC();

Description

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

Return value

CCnaConverterList*

New converter list


Release()

void Release();

Description

Releases all loaded converter DLLs.

You must delete all converters obtained from the list before calling this function.


~CCnaConverterList()

~CCnaConverterList();

Description

Destructor.

This releases all loaded converter DLLs.

[Top]


Obtaining converters


NewConverterL()

CConverterBase* NewConverterL(TUid aUid);

Description

Gets a new converter for the specified UID.

Parameters

TUid aUid

Converter UID

Return value

CConverterBase*

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


ConvFromL()

TUid ConvFromL(const TDataType& aMimeType);

Description

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

Parameters

const TDataType& aMimeType

Source data type

Return value

TUid

Converter UID


ConvToL()

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


ConverterL()

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

Description

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

Parameters

const TDataType& aFrom

Source data type

const TDataType& aTo

Target data type

Return value

TUid

Converter UID


ConvFromListL()

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

const CArrayFix<SConverterInfo>* aSConverterInfoArray

On return, array of converter information objects for all suitable converters


ConvToListL()

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

const CArrayFix<SConverterInfo>* aSConverterInfoArray

On return, an array of converter information objects for all suitable converters


Count()

TInt Count();

Description

Gets the total number of converters.

Return value

TInt

Total number of converters


MimeTypeFrom()

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


MimeTypeTo()

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


UpdateL()

void UpdateL();

Description

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