Class CMMFMetaDataEntry

class CMMFMetaDataEntry : public CBase;

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.

Derivation

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

• CMMFMetaDataEntry - A piece of meta data.

Members

Defined in CMMFMetaDataEntry:

• ExternalizeL(RWriteStream &)constWrites the data contained within the object to a stream so it can be copied over...
• InternalizeL(RReadStream &)Reads data from a stream and copies it into this object. Used when copying a met...
• Name()constReturns the name, or category, of the meta data.
• NewL()Default constructor. Returns a blank meta data object. To be used when internali...
• NewL(const CMMFMetaDataEntry &)Copy constructor. Returns a replica of the meta data passed in.
• NewL(const TDesC &,const TDesC &)Constructs a new meta data object using a name and value.
• SetNameL(const TDesC &)Sets the name, or category, of the meta data.
• SetValueL(const TDesC &)Sets the value field of the meta data.
• Value()constReturns the value field of the meta data.
• ~CMMFMetaDataEntry()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

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

Description

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>

Parameters

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

Return value

CMMFMetaDataEntry * The newly created meta data object.

IMPORT_C static CMMFMetaDataEntry* NewL(const CMMFMetaDataEntry &aOther);

Description

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

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

Parameters

const CMMFMetaDataEntry &aOther The meta data to be copied.

Return value

CMMFMetaDataEntry * The newly created meta data object.

IMPORT_C static CMMFMetaDataEntry* NewL();

Description

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.

Return value

CMMFMetaDataEntry * The newly created meta data object.

IMPORT_C ~CMMFMetaDataEntry();

Description

Destructor.

IMPORT_C const TDesC& Name() const;

Description

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

Return value

const TDesC16 & The name of the meta data object.

IMPORT_C const TDesC& Value() const;

Description

Returns the value field of the meta data.

Return value

const TDesC16 & The value field of the meta data object.

IMPORT_C void SetNameL(const TDesC &aName);

Description

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

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

Parameters

const TDesC16 &aName The new name of the meta data object

IMPORT_C void SetValueL(const TDesC &aValue);

Description

Sets the value field of the meta data.

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

Parameters

const TDesC16 &aValue The new value field of the meta data object

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

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.

Parameters

RWriteStream &aStream The stream to be written to.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

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.

Parameters

RReadStream &aStream The stream to be read.