CCnvCharacterSetNames Class Reference

#include <convnames.h>

Link against: convnames.lib

class CCnvCharacterSetNames : public CBase

Inherits from

CCnvCharacterSetNames
- CBase

Public Member Functions
virtual	~CCnvCharacterSetNames()
IMPORT_C TUint	IdentifierAtIndex(TInt)
IMPORT_C TInt	IndexOfIdentifier(TUint)
IMPORT_C CCnvCharacterSetNames *	NewL(RFs &, const TArray< CCnvCharacterSetConverter::SCharacterSet > &)
IMPORT_C CCnvCharacterSetNames *	NewLC(RFs &, const TArray< CCnvCharacterSetConverter::SCharacterSet > &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

A localised list of the names of non-Unicode character set encodings supported on the phone.

For each character conversion plug-in DLL, there are one or more resource files which contain the name of the encoding translated into a different language.

This class populates a list of the names of all encodings supported on the phone by reading the appropriate resource file for each one. The list is sorted according to the collation rules for the device's current locale.

The virtual functions MdcaCount() (returns the number of items in the list) and MdcaPoint() (returns a TPtrC for the item at the given index) are implemented privately in this class. Users of this class can call them through the MDesCArray interface.

Constructor & Destructor Documentation

~CCnvCharacterSetNames ( )

IMPORT_C

~CCnvCharacterSetNames

(

)

[virtual]

Deletes the array of named plug-ins owned by the object prior to its destruction.

Member Function Documentation

IdentifierAtIndex ( TInt )

IMPORT_C TUint

IdentifierAtIndex

(

TInt

aIndex

)

const

Gets the character set identifier at the specified index into the list.

Parameters
aIndex	The index into the list. Must be within the bounds of the array, or a panic occurs.

Return Value: The character set identifier at the specified index.

IndexOfIdentifier ( TUint )

IMPORT_C TInt

IndexOfIdentifier

(

TUint

aIdentifier

)

const

Gets the index into the sorted list of the character set identifier specified.

Parameters
aIdentifier	The character set identifier. This must not be zero, or a panic occurs.

Return Value: The index into the list of the character set identifier, or KErrNotFound if the identifier does not exist in the list.

NewL ( RFs &, const TArray< CCnvCharacterSetConverter::SCharacterSet > & )

IMPORT_C CCnvCharacterSetNames *	NewL	(	RFs &	aFileServerSession,
			const TArray< CCnvCharacterSetConverter::SCharacterSet > &	aArrayOfCharacterSetsAvailable
		)	[static]

Allocates and constructs a localised list of character set encoding names.

Parameters
aFileServerSession	A connected session with the file server.
aArrayOfCharacterSetsAvailable	The array of character sets available on the phone. This can be created using CCnvCharacterSetConverter::CreateArrayOfCharacterSetsAvailableL() or CreateArrayOfCharacterSetsAvailableLC().

Return Value: Pointer to the newly created object.

NewLC ( RFs &, const TArray< CCnvCharacterSetConverter::SCharacterSet > & )

IMPORT_C CCnvCharacterSetNames *	NewLC	(	RFs &	aFileServerSession,
			const TArray< CCnvCharacterSetConverter::SCharacterSet > &	aArrayOfCharacterSetsAvailable
		)	[static]

Allocates and constructs a localised list of character set encoding names. Puts a pointer to the object on the cleanup stack.

Parameters
aFileServerSession	A connected session with the file server.
aArrayOfCharacterSetsAvailable	The array of character sets available on the phone. This can be created using CCnvCharacterSetConverter::CreateArrayOfCharacterSetsAvailableL() or CreateArrayOfCharacterSetsAvailableLC().

Return Value: Pointer to the newly created object.