Symbian^3 Application Developer Library >

CObexMtmHeader Class Reference

class CObexMtmHeader : public CBase

Base class for OBEX object headers. Allows them to be stored and restored to and from the CMsvStore .

Inherits from

Public Member Functions
~CObexMtmHeader ()
IMPORT_C TPtrC8 Addr ()
IMPORT_C TPtrC8 ConnectionID ()
IMPORT_C void ExternalizeL ( RMsvWriteStream &)
IMPORT_C void InternalizeL ( RMsvReadStream &)
IMPORT_C TInt Length ()
IMPORT_C TPtrC Name ()
IMPORT_C void RestoreL (const CMsvStore &)
IMPORT_C void SetAddrL (const TDesC8 &)
IMPORT_C void SetConnectionIDL (const TDesC8 &)
IMPORT_C void SetLength ( TInt )
IMPORT_C void SetNameL (const TDesC &)
IMPORT_C void SetSubjectL (const TDesC &)
IMPORT_C void SetTargetL (const TDesC8 &)
IMPORT_C void SetTime (const TTime &)
IMPORT_C void SetTypeL (const TDesC8 &)
IMPORT_C void StoreL ( CMsvStore &)
IMPORT_C TPtrC Subject ()
IMPORT_C TPtrC8 Target ()
IMPORT_C const TTime & Time ()
IMPORT_C TPtrC8 Type ()
Protected Member Functions
CObexMtmHeader ( TUid , TInt32 )
IMPORT_C void BaseConstructL ()
IMPORT_C void BaseExternalizeL ( RMsvWriteStream &)
IMPORT_C void BaseInternalizeL ( RMsvReadStream &)
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()
Protected Attributes
HBufC8 * iConnectionID
TInt iLength
HBufC * iName
const TUid iStreamUid
const TInt32 iStreamVersion
HBufC * iSubject
HBufC8 * iTarget
TTime iTime
HBufC8 * iType

Constructor & Destructor Documentation

CObexMtmHeader(TUid, TInt32)

IMPORT_C CObexMtmHeader ( TUid aStreamUid,
TInt32 aStreamVersion
) [protected]

Default constructor, which assigns the TUid for the stream and stream version

Parameters

TUid aStreamUid Uid of the header stream--specified in the derived class
TInt32 aStreamVersion Version number for the stream, must be specified in the derived classes and incremented each time a new version of the stream is implemented.

~CObexMtmHeader()

IMPORT_C ~CObexMtmHeader ( )

Destructor which deletes all of the HBufC members

Member Functions Documentation

Addr()

IMPORT_C TPtrC8 Addr ( ) const [pure virtual]

BaseConstructL()

IMPORT_C void BaseConstructL ( ) [protected]

Leaving constructor, which must be called by the base classes to initialise the HBufC members

BaseExternalizeL(RMsvWriteStream &)

IMPORT_C void BaseExternalizeL ( RMsvWriteStream & aWriteStream ) const [protected]
Externalizes CObexMtmHeader object to a stream. Must be called by the derived class BEFORE that class externalizes
leave
KErrXXX Standard EPOC stream leave codes

Parameters

RMsvWriteStream & aWriteStream The stream to be written to

BaseInternalizeL(RMsvReadStream &)

IMPORT_C void BaseInternalizeL ( RMsvReadStream & aReadStream ) [protected]

Internalizes the CObexMtmHeader object from a stream.Must be called by the derived class BEFORE that class internalizes

leave
KErrXXX Standard EPOC stream leave codes

Parameters

RMsvReadStream & aReadStream The stream to be read from

ConnectionID()

IMPORT_C TPtrC8 ConnectionID ( ) const

Returns the ConnectionID header value.

ExternalizeL(RMsvWriteStream &)

IMPORT_C void ExternalizeL ( RMsvWriteStream & aWriteStream ) const [pure virtual]

Parameters

RMsvWriteStream & aWriteStream

InternalizeL(RMsvReadStream &)

IMPORT_C void InternalizeL ( RMsvReadStream & aReadStream ) [pure virtual]

Parameters

RMsvReadStream & aReadStream

Length()

IMPORT_C TInt Length ( ) const

Returns the Length header value

Name()

IMPORT_C TPtrC Name ( ) const

Returns the Name header value.

RestoreL(const CMsvStore &)

IMPORT_C void RestoreL ( const CMsvStore & aStore )
Opens a stream in aStore and internalises this object from it.
leave
KErrXXX Standard EPOC stream leave codes.
leave
KErrAccessDenied aStore is not opened with read access.

Parameters

const CMsvStore & aStore The store from which this object is to be restored. Note this must be open with read or read/write access or this function will leave.

SetAddrL(const TDesC8 &)

IMPORT_C void SetAddrL ( const TDesC8 & aSubject ) [pure virtual]

Parameters

const TDesC8 & aSubject

SetConnectionIDL(const TDesC8 &)

IMPORT_C void SetConnectionIDL ( const TDesC8 & aSubject )

Sets the ConnectionID header value.

leave
KErrXXX Standard EPOC error codes if allocation of a buffer to hold the ConnectionID header fails.

Parameters

const TDesC8 & aSubject

SetLength(TInt)

IMPORT_C void SetLength ( TInt aLength )

Sets the Length header value

Parameters

TInt aLength The new Length header value

SetNameL(const TDesC &)

IMPORT_C void SetNameL ( const TDesC & aSubject )
Sets the Name header value.
leave
KErrXXX Standard EPOC error codes if allocation of a buffer to hold the Name header fails.

Parameters

const TDesC & aSubject The new Name header value

SetSubjectL(const TDesC &)

IMPORT_C void SetSubjectL ( const TDesC & aSubject )

Sets the Subject header value.

leave
KErrXXX Standard EPOC error codes if allocation of a buffer to hold the Subject header fails.

Parameters

const TDesC & aSubject

SetTargetL(const TDesC8 &)

IMPORT_C void SetTargetL ( const TDesC8 & aSubject )

Sets the ConnectionID header value.

leave
KErrXXX Standard EPOC error codes if allocation of a buffer to hold the Target header fails.

Parameters

const TDesC8 & aSubject

SetTime(const TTime &)

IMPORT_C void SetTime ( const TTime & aTime )

Sets the Time header value

Parameters

const TTime & aTime The new Time header value

SetTypeL(const TDesC8 &)

IMPORT_C void SetTypeL ( const TDesC8 & aSubject )

Sets the Type header value.

leave
KErrXXX Standard EPOC error codes if allocation of a buffer to hold the Type header fails.

Parameters

const TDesC8 & aSubject The new Type header value

StoreL(CMsvStore &)

IMPORT_C void StoreL ( CMsvStore & aStore ) const

Creates a stream in aStore and externalises this object to it.

leave
KErrXXX Standard EPOC stream leave codes.
leave
KErrAccessDenied aStore is not opened with write access.

Parameters

CMsvStore & aStore The store to which this object is to be stored. Note this must be open with write access or this function will leave.

Subject()

IMPORT_C TPtrC Subject ( ) const

Returns the Subject header value.

Target()

IMPORT_C TPtrC8 Target ( ) const

Returns the Target header value.

Time()

IMPORT_C const TTime & Time ( ) const

Returns the Time header value

Type()

IMPORT_C TPtrC8 Type ( ) const

Returns the Type header value.

Member Data Documentation

HBufC8 * iConnectionID

HBufC8 * iConnectionID [protected]

TInt iLength

TInt iLength [protected]

HBufC * iName

HBufC * iName [protected]

const TUid iStreamUid

const TUid iStreamUid [protected]

const TInt32 iStreamVersion

const TInt32 iStreamVersion [protected]

HBufC * iSubject

HBufC * iSubject [protected]

HBufC8 * iTarget

HBufC8 * iTarget [protected]

TTime iTime

TTime iTime [protected]

HBufC8 * iType

HBufC8 * iType [protected]

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.