CObexHeaderList Class Reference

#include <app/obexheaderlist.h>

Link against: obexmtmutil.lib

class CObexHeaderList : public CBase

Inherits from

CObexHeaderList
- CBase

Public Member Functions
	~CObexHeaderList()
IMPORT_C TInt	AddHeader(const CObexHeader *)
IMPORT_C void	ExportToAttachmentL(CMsvAttachment &)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	ImportFromAttachmentL(CMsvAttachment &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C CObexHeaderList *	NewL()
IMPORT_C CObexHeaderList *	NewLC()

Protected Member Functions
IMPORT_C void	AddHeadersToBaseObjectL(CObexBaseObject &)
IMPORT_C TInt	Count()
IMPORT_C CObexHeader *&	ObexHeaderL(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

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

Constructor & Destructor Documentation

~CObexHeaderList ( )

IMPORT_C

~CObexHeaderList

(

)

Destructor which frees all allocated memory with the list.

Destructor which frees all allocated memory with the list

Member Function Documentation

AddHeader ( const CObexHeader * )

IMPORT_C TInt

AddHeader

(

const CObexHeader *

aHeader

)

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 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
aHeader	is a pointer to a constant CObexHeader object

Return Value: KErrNone, if the operation is successful, otherwise one of the system wide error codesKErrNone, if the operation is successful, otherwise one of the system wide error codes

AddHeadersToBaseObjectL ( CObexBaseObject & )

IMPORT_C void

AddHeadersToBaseObjectL

(

CObexBaseObject &

aObexBaseObj

)

[protected]

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

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

Parameters
aObexBaseObj	is a reference to a CObexBaseObject

Leave Codes
Error	System wide error code
it	may leave with one of the system wide error code

Count ( )

IMPORT_C TInt

Count

(

)

const [protected]

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

Return the number of CObexHeader object pointers contained in the list

Return Value: The number of CObexHeader object pointers in the listreturn the number of CObexHeader object pointers in the list

ExportToAttachmentL ( CMsvAttachment & )

IMPORT_C void

ExportToAttachmentL

(

CMsvAttachment &

aAttachment

)

const

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

Parameters
aAttachment	The attachment to store the header list for.

Leave Codes
System-wide	error codes.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aWriteStream

)

const

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

Parameters
aWriteStream	is a reference to a RMsvWriteStream

Leave Codes
it	may leave with one of the system wide error code

ImportFromAttachmentL ( CMsvAttachment & )

IMPORT_C void

ImportFromAttachmentL

(

CMsvAttachment &

aAttachment

)

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
aAttachment	The attachment to retieve the header list from.

Leave Codes
System-wide	error codes.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aReadStream

)

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

Parameters
aReadStream	is a reference to a RMsvReadStream

Leave Codes
it	may leave with one of the system wide error code

NewL ( )

IMPORT_C CObexHeaderList *

NewL

(

)

[static]

Factory function to return a new CObexHeaderList. Factory function to return a CObexHeaderList*

Return Value: New CObexHeaderList object

NewLC ( )

IMPORT_C CObexHeaderList *

NewLC

(

)

[static]

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

Return Value: New CObexHeaderList object

ObexHeaderL ( TInt )

IMPORT_C CObexHeader *&

ObexHeaderL

(

TInt

aPos

)

[protected]

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

Parameters
aPos	is a list index specifying the CObexHeader object pointer to be returned

Return Value: A non constant reference to the CObexHeader object pointerreturn a non constant reference to the CObexHeader object pointer

Leave Codes
KErrArgument	aPos is out of range
KErrNotFound	The list is empty
leave	if aPos is out of range(KErrArgument) or the list is empty (KErrNotFound)