CSIPToHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <siptoheader.h>

Inherits CSIPFromToHeaderBase.

Detailed Description

PublishedAll

Released

Class provides functions for setting and getting SIP "To" header fields.


Public Member Functions
IMPORT_C�	~CSIPToHeader ()
�	Destructor, deletes the resources of CSIPToHeader.
IMPORT_C CSIPHeaderBase *�	CloneL () const
�	From CSIPHeaderBase CloneL.
IMPORT_C RStringF�	Name () const
�	From CSIPHeaderBase Name.
RStringF�	CompactName () const
Static Public Member Functions
static IMPORT_C CSIPToHeader *�	DecodeL (const TDesC8 &aValue)
�	Constructs a CSIPToHeader from textual representation of the header's value part.
static IMPORT_C CSIPToHeader *�	NewL (CSIPAddress *aSIPAddress)
�	Creates a new instance of CSIPToHeader.
static IMPORT_C CSIPToHeader *�	NewLC (CSIPAddress *aSIPAddress)
�	Creates a new instance of CSIPToHeader and puts it to CleanupStack.
static IMPORT_C CSIPToHeader *�	NewL (const CSIPFromToHeaderBase &aHeader)
�	Creates a deep-copy of a CSIPFromToHeaderBase Note that this function can be used for creating a To-header using an existing From-header.
static IMPORT_C CSIPToHeader *�	NewLC (const CSIPFromToHeaderBase &aHeader)
�	Creates a deep-copy of a CSIPFromToHeaderBase and puts it to CleanupStack Note that this function can be used for creating a To-header using an existing From-header.
static IMPORT_C CSIPHeaderBase *�	InternalizeValueL (RReadStream &aReadStream)
�	Constructs an instance of a CSIPToHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase >�	BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

IMPORT_C CSIPToHeader::~CSIPToHeader

(�

�)�

�	Destructor, deletes the resources of CSIPToHeader.

Member Function Documentation

static RPointerArray<CSIPHeaderBase> CSIPToHeader::BaseDecodeL (� const TDesC8 &� aValue �)� [static]

�

IMPORT_C CSIPHeaderBase* CSIPToHeader::CloneL (� �)� const [virtual]

�	From CSIPHeaderBase CloneL. Implements CSIPHeaderBase.

RStringF CSIPToHeader::CompactName (� �)� const [virtual]

�	Reimplemented from CSIPHeaderBase.

static IMPORT_C CSIPToHeader* CSIPToHeader::DecodeL (� const TDesC8 &� aValue �)� [static]

�

Constructs a CSIPToHeader from textual representation of the header's value part.

Parameters:

aValue�

a value part of a "To"-header (e.g. "User <user@host>")

Returns:: a new instance of CSIPToHeader

static IMPORT_C CSIPHeaderBase* CSIPToHeader::InternalizeValueL (� RReadStream &� aReadStream �)� [static]

�

Constructs an instance of a CSIPToHeader from a RReadStream.

Parameters:

aReadStream�

a stream containing the value of the externalized object (header name not included).

Returns:: an instance of a CSIPToHeader

IMPORT_C RStringF CSIPToHeader::Name (� �)� const [virtual]

�	From CSIPHeaderBase Name. Implements CSIPHeaderBase.

static IMPORT_C CSIPToHeader* CSIPToHeader::NewL (� const CSIPFromToHeaderBase &� aHeader �)� [static]

�

Creates a deep-copy of a CSIPFromToHeaderBase Note that this function can be used for creating a To-header using an existing From-header.

Parameters:

aHeader�

CSIPFromToHeaderBase to be copied

Returns:: a new instance of CSIPToHeader

static IMPORT_C CSIPToHeader* CSIPToHeader::NewL (� CSIPAddress *� aSIPAddress �)� [static]

�

Creates a new instance of CSIPToHeader.

Precondition:: aSIPAddress != 0

Parameters:

aSIPAddress�

a name-address, the ownership is transferred,

Returns:: a new instance of CSIPToHeader

static IMPORT_C CSIPToHeader* CSIPToHeader::NewLC (� const CSIPFromToHeaderBase &� aHeader �)� [static]

�

Creates a deep-copy of a CSIPFromToHeaderBase and puts it to CleanupStack Note that this function can be used for creating a To-header using an existing From-header.

Parameters:

aHeader�

CSIPFromToHeaderBaseto to be copied