Class CObexHeaderList

class CObexHeaderList : public CBase;

Description

Encapsulates and owns a list of CObexHeader objects. Public users of this class can add CObexHeader objects

Derivation

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

• CObexHeaderList - Encapsulates and owns a list of CObexHeader objects. Public users of this class ...

Members

Defined in CObexHeaderList:

• AddHeader(const CObexHeader *)Add a CObexHeader object to the list. The CObexHeader object added should have i...
• AddHeadersToBaseObjectL(CObexBaseObject &)Add all the CObexHeader objects contained in a list to a CObexBaseObject.
• Count()constReturn the number of CObexHeader object pointers contained in the list.
• ExportToAttachmentL(CMsvAttachment &)constExports the Obex header list to the attachment. The header list is then stored w...
• ExternalizeL(RWriteStream &)constExternalise the contents of the CObexHeaderList class to a stream in CMsvStore...
• ImportFromAttachmentL(CMsvAttachment &)Imports the Obex header list from the attachment. The header list is retrieved a...
• InternalizeL(RReadStream &)Internalise the contents of the CObexHeaderList class from a stream in CMsvStore...
• NewL()Factory function to return a new CObexHeaderList.
• NewLC()Factory function to return a new CObexHeaderList and leave it on the cleanup sta...
• ObexHeaderL(TInt)Get a non constant reference to the CObexHeader object pointer at position aPos ...
• ~CObexHeaderList()Destructor which frees all allocated memory with the list.

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 CObexHeaderList* NewL();

Description

Factory function to return a new CObexHeaderList.

Return value

IMPORT_C static CObexHeaderList* NewLC();

Description

Factory function to return a new CObexHeaderList and leave it on the cleanup stack.

Return value

IMPORT_C ~CObexHeaderList();

Description

Destructor which frees all allocated memory with the list.

IMPORT_C TInt AddHeader(const CObexHeader *aHeader);

Description

Add a CObexHeader object to the list. The CObexHeader object added should have its attribute, header ID and header value set before it is added to the list. CObexHeaderlist will not change these values of its contained CObexHeader objects

Parameters

Return value

IMPORT_C void ExportToAttachmentL(CMsvAttachment &aAttachment) const;

Description

Exports the Obex header list to the attachment. The header list is then stored with the attachment.

Parameters

Leave codes

IMPORT_C void ImportFromAttachmentL(CMsvAttachment &aAttachment);

Description

Imports the Obex header list from the attachment. The header list is retrieved and stored in this object. Any existing header data is over-written with the headers from the attachment. If the headers have not been set, this obex list will still be over written and result in zero headers.

Parameters

Leave codes

IMPORT_C void ExternalizeL(RWriteStream &aWriteStream) const;

Description

Externalise the contents of the CObexHeaderList class to a stream in CMsvStore

Parameters

Leave codes

IMPORT_C void InternalizeL(RReadStream &aReadStream);

Description

Internalise the contents of the CObexHeaderList class from a stream in CMsvStore

Parameters

Leave codes

protected: IMPORT_C void AddHeadersToBaseObjectL(CObexBaseObject &aObexBaseObj);

Description

Add all the CObexHeader objects contained in a list to a CObexBaseObject.

Parameters

Leave codes

protected: IMPORT_C TInt Count() const;

Description

Return the number of CObexHeader object pointers contained in the list.

Return value

protected: IMPORT_C CObexHeader *& ObexHeaderL(TInt aPos);

Description

Get a non constant reference to the CObexHeader object pointer at position aPos into the list.

Parameters

Return value

Leave codes