CObexHeaderList Class Reference
|
class CObexHeaderList : public CBase
|
Encapsulates and owns a list of CObexHeader objects. Public users of this class can add CObexHeader objects
Constructor & Destructor Documentation
CObexHeaderList()
|
CObexHeaderList
|
(
|
)
|
[private]
|
Constructor function used in 2 phase construction in
NewLC()
~CObexHeaderList()
|
IMPORT_C
|
~CObexHeaderList
|
(
|
)
|
|
Destructor which frees all allocated memory with the list.
Destructor which frees all allocated memory with the list
Member Functions 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
|
const CObexHeader * aHeader
|
is a pointer to a constant CObexHeader object
|
AddHeadersToBaseObjectL(CObexBaseObject &)
|
IMPORT_C void
|
AddHeadersToBaseObjectL
|
(
|
CObexBaseObject &
|
aObexBaseObj
|
)
|
[protected]
|
Add all the CObexHeader objects contained in a list to a CObexBaseObject.
-
leave
-
Error System wide error code
Add all the CObexHeader objects contained in a list to a CObexBaseObject
-
leave
-
it may leave with one of the system wide error code
Parameters
|
CObexBaseObject & aObexBaseObj
|
is a reference to a CObexBaseObject
|
ConstructL()
|
void
|
ConstructL
|
(
|
)
|
[private]
|
Leaving constructor function used in 2 phase construction in
NewLC()
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
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.
-
leave
-
System-wide error codes.
Parameters
|
CMsvAttachment
& aAttachment
|
The attachment to store the header list for.
|
ExternalizeL(RWriteStream &)
|
IMPORT_C void
|
ExternalizeL
|
(
|
RWriteStream
&
|
aWriteStream
|
)
|
const
|
Externalise the contents of the
CObexHeaderList
class to a stream in
CMsvStore
-
leave
-
it may leave with one of the system wide error code
Parameters
|
RWriteStream
& aWriteStream
|
is a reference to a RMsvWriteStream
|
ImportFromAttachmentL(CMsvAttachment &)
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.
-
leave
-
System-wide error codes.
Parameters
|
CMsvAttachment
& aAttachment
|
The attachment to retieve the header list from.
|
InternalizeL(RReadStream &)
|
IMPORT_C void
|
InternalizeL
|
(
|
RReadStream
&
|
aReadStream
|
)
|
|
Internalise the contents of the
CObexHeaderList
class from a stream in
CMsvStore
-
leave
-
it may leave with one of the system wide error code
Parameters
|
RReadStream
& aReadStream
|
is a reference to a RMsvReadStream
|
NewL()
Factory function to return a new
CObexHeaderList
. Factory function to return a CObexHeaderList*
NewLC()
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
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.
-
leave
-
KErrArgument aPos is out of range
-
leave
-
KErrNotFound The list is empty
Get a non constant reference to the CObexHeader object pointer at position aPos into the list.
-
leave
-
leave if aPos is out of range(KErrArgument) or the list is empty (KErrNotFound)
Parameters
|
TInt
aPos
|
is a list index specifying the CObexHeader object pointer to be returned
|
Member Data Documentation
RPointerArray< CObexHeader > * iObexHeaders
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.