CMMFMetaDataEntry Class Reference

#include <mmf/common/mmfcontrollerframeworkbase.h>

Link against: mmfcontrollerframework.lib

class CMMFMetaDataEntry : public CBase, public CBase

Inherits from

CMMFMetaDataEntry
- CBase
- CBase

Public Member Functions
	~CMMFMetaDataEntry()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C const TDesC &	Name()
IMPORT_C CMMFMetaDataEntry *	NewL(const TDesC &, const TDesC &)
IMPORT_C CMMFMetaDataEntry *	NewL(const CMMFMetaDataEntry &)
IMPORT_C CMMFMetaDataEntry *	NewL()
IMPORT_C void	SetNameL(const TDesC &)
IMPORT_C void	SetValueL(const TDesC &)
IMPORT_C const TDesC &	Value()

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 piece of meta data.

Meta data is often contained in the header of multimedia clips and is used to define attributes such as the author and copyright details.

Each piece of meta data has a name, or category, and a value.

Since: 7.0s

Constructor & Destructor Documentation

~CMMFMetaDataEntry ( )

IMPORT_C

~CMMFMetaDataEntry

(

)

Destructor.

Since: 7.0s

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Writes the data contained within the object to a stream so it can be copied over IPC or written to a file.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameters
aStream	The stream to be written to.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Reads data from a stream and copies it into this object. Used when copying a meta data object over IPC or reading it from a file.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameters
aStream	The stream to be read.

Name ( )

IMPORT_C const TDesC &

Name

(

)

const

Returns the name, or category, of the meta data.

Since: 7.0s

Return Value: The name of the meta data object.

NewL ( const TDesC &, const TDesC & )

IMPORT_C CMMFMetaDataEntry *	NewL	(	const TDesC &	aName,
			const TDesC &	aValue
		)	[static]

Constructs a new meta data object using a name and value.

This method can leave with one of the standard system-wide error codes.

An example of a name might be:

	For example, <Copyright>

An example of a value might be:

	<Symbian (c) 2002>

Since: 7.0s

Parameters
aName	The name, or category, to be given to this piece of meta data.
aValue	The value of this piece of meta data.

Return Value: The newly created meta data object.

NewL ( const CMMFMetaDataEntry & )

IMPORT_C CMMFMetaDataEntry *

NewL

(

const CMMFMetaDataEntry &

aOther

)

[static]

Copy constructor. Returns a replica of the meta data passed in.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameters
aOther	The meta data to be copied.

Return Value: The newly created meta data object.

NewL ( )

IMPORT_C CMMFMetaDataEntry *

NewL

(

)

[static]

Default constructor. Returns a blank meta data object. To be used when internalizing data into the object.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Return Value: The newly created meta data object.

SetNameL ( const TDesC & )

IMPORT_C void

SetNameL

(

const TDesC &

aName

)

Sets the name, or category, of the meta data.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameters
aName	The new name of the meta data object

SetValueL ( const TDesC & )

IMPORT_C void

SetValueL

(

const TDesC &

aValue

)

Sets the value field of the meta data.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameters
aValue	The new value field of the meta data object

Value ( )

IMPORT_C const TDesC &

Value

(

)

const

Returns the value field of the meta data.

Since: 7.0s

Return Value: The value field of the meta data object.