CSIPFromHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipfromheader.h>

Inherits CSIPFromToHeaderBase.

Detailed Description

PublishedAll

Released

Class provides functions for setting and getting SIP "From" header.


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

Constructor & Destructor Documentation

IMPORT_C CSIPFromHeader::~CSIPFromHeader

(�

�)�

�	Destructor, deletes the resources of CSIPFromHeader.

Member Function Documentation

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

�

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

�	From CSIPHeaderBase CloneL. Implements CSIPHeaderBase.

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

�	Reimplemented from CSIPHeaderBase.

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

�

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

Parameters:

aValue�

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

Returns:: a new instance of CSIPFromHeader

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

�

Constructs an instance of a CSIPFromHeader from a RReadStream.

Parameters:

aReadStream�

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

Returns:: an instance of a CSIPFromHeader

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

�	From CSIPHeaderBase Name. Implements CSIPHeaderBase.

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

�

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

Parameters:

aHeader�

CSIPFromToHeaderBase to be copied

Returns:: a new instance of CSIPFromHeader

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

�

Creates a new instance of CSIPFromHeader.

Precondition:: aSIPAddress != 0

Parameters:

aSIPAddress�

a name-address, the ownership is transferred.

Returns:: a new instance of CSIPFromHeader

static IMPORT_C CSIPFromHeader* CSIPFromHeader::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 From-header using an existing To-header.

Parameters:

aHeader�

CSIPFromToHeaderBase to be copied