ContentAccess::CMetaDataArray Class Reference

#include <caf/metadataarray.h>

Link against: cafutils.lib

class ContentAccess::CMetaDataArray : public CBase

Inherits from

ContentAccess::CMetaDataArray
- CBase

Public Member Functions
virtual	~CMetaDataArray()
IMPORT_C void	AddL(const TDesC8 &, const TDesC8 &)
IMPORT_C void	AddL(const TDesC &, const TDesC &)
IMPORT_C TInt	Count()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C CMetaDataArray *	NewL()
IMPORT_C CMetaDataArray *	NewL(RReadStream &)
IMPORT_C CMetaDataArray *	NewLC()
IMPORT_C const TDesC &	SearchL(const TDesC &, TBool)
IMPORT_C const TDesC8 &	SearchL(const TDesC8 &, TBool)
IMPORT_C const CMetaData &	operator[](TInt)

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

Stores an array of CMetaData objects for use in a supplier import operation

It provides search and routines (for both 8 bit and Unicode) to find the value corresponding to a particular field in the array.

Applications should use the unicode search function whenever possible because it removes the risk of losing information during the unicode to 8 bit conversion.

Constructor & Destructor Documentation

~CMetaDataArray ( )

~CMetaDataArray

(

)

[virtual]

Destructor

Member Function Documentation

AddL ( const TDesC8 &, const TDesC8 & )

IMPORT_C void	AddL	(	const TDesC8 &	aField,
			const TDesC8 &	aData
		)

Adds a new meta data,

Parameters
aField	The name used to index the value of interest
aData	The data

AddL ( const TDesC &, const TDesC & )

IMPORT_C void	AddL	(	const TDesC &	aField,
			const TDesC &	aData
		)

Adds a new meta data,

Parameters
aField	The name used to index the value of interest
aData	The data

Count ( )

IMPORT_C TInt

Count

(

)

const

The number of metadata objects in the list

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes the CMetaDataArray object to a stream.

Parameters
aStream	The stream to write the header information to.

NewL ( )

IMPORT_C CMetaDataArray *

NewL

(

)

[static]

NewL ( RReadStream & )

IMPORT_C CMetaDataArray *

NewL

(

RReadStream &

aStream

)

[static]

Construct a CMetaDataArray from a stream

Parameters
aStream	the stream containing the metadata array

Return Value: a new CMetaDataArray

NewLC ( )

IMPORT_C CMetaDataArray *

NewLC

(

)

[static]

SearchL ( const TDesC &, TBool )

IMPORT_C const TDesC &	SearchL	(	const TDesC &	aField,
			TBool	aMatchCase = EFalse
		)	const

Find the unicode data for a given unicode field.

Parameters
aField	The field to retrieve
aMatchCase	ETrue To perform case sensitive search, EFalse - To perform non case sensitive search

Return Value: The corresponding data or else a zero length string if the field was not found

SearchL ( const TDesC8 &, TBool )

IMPORT_C const TDesC8 &	SearchL	(	const TDesC8 &	aField8,
			TBool	aMatchCase = EFalse
		)	const

Find the 8 bit data for a given 8 bit field.

Parameters
aField8	The field to retrieve
aMatchCase	ETrue To perform case sensitive search, EFalse - To perform non case sensitive search

Return Value: The corresponding data or else a zero length string if the field was not found

operator[] ( TInt )

IMPORT_C const CMetaData &

operator[]

(

TInt

aIndex

)

const

Retrieves the MetaData at the given index

Parameters
aIndex	The index of the meta-data