CObexHeaderList Class Reference

#include <app/obexheaderlist.h>

Link against: obexmtmutil.lib

class CObexHeaderList : public CBase

Inherits from

  • CObexHeaderList
    Public Member Functions
    ~CObexHeaderList()
    IMPORT_C TIntAddHeader(const CObexHeader *)
    IMPORT_C voidExportToAttachmentL(CMsvAttachment &)
    IMPORT_C voidExternalizeL(RWriteStream &)
    IMPORT_C voidImportFromAttachmentL(CMsvAttachment &)
    IMPORT_C voidInternalizeL(RReadStream &)
    IMPORT_C CObexHeaderList *NewL()
    IMPORT_C CObexHeaderList *NewLC()
    Protected Member Functions
    IMPORT_C voidAddHeadersToBaseObjectL(CObexBaseObject &)
    IMPORT_C TIntCount()
    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 TIntAddHeader(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

    ParameterDescription
    aHeaderis a pointer to a constant CObexHeader object

    Returns: 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 voidAddHeadersToBaseObjectL(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
    ParameterDescription
    aObexBaseObjis a reference to a CObexBaseObject

    Count ( )

    IMPORT_C TIntCount()const [protected]

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

    Return the number of CObexHeader object pointers contained in the list

    Returns: The number of CObexHeader object pointers in the listreturn the number of CObexHeader object pointers in the list

    ExportToAttachmentL ( CMsvAttachment & )

    IMPORT_C voidExportToAttachmentL(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.
    ParameterDescription
    aAttachmentThe attachment to store the header list for.

    ExternalizeL ( RWriteStream & )

    IMPORT_C voidExternalizeL(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
    ParameterDescription
    aWriteStreamis a reference to a RMsvWriteStream

    ImportFromAttachmentL ( CMsvAttachment & )

    IMPORT_C voidImportFromAttachmentL(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.
    leave
    System-wide error codes.
    ParameterDescription
    aAttachmentThe attachment to retieve the header list from.

    InternalizeL ( RReadStream & )

    IMPORT_C voidInternalizeL(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
    ParameterDescription
    aReadStreamis a reference to a RMsvReadStream

    NewL ( )

    IMPORT_C CObexHeaderList *NewL()[static]

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

    Returns: 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

    Returns: New CObexHeaderList object

    ObexHeaderL ( TInt )

    IMPORT_C CObexHeader *&ObexHeaderL(TIntaPos)[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)
    ParameterDescription
    aPosis a list index specifying the CObexHeader object pointer to be returned

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

    © Nokia 2011.