CSIPFromToHeaderBase Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipfromtoheaderbase.h>

Inherits CSIPParameterHeaderBase.

Inherited by CSIPFromHeader, and CSIPToHeader.

Detailed Description

PublishedAll

Released

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

This is an abstract class and cannot be instantiated.


Public Member Functions
virtual IMPORT_C�	~CSIPFromToHeaderBase ()
�	Destructor, deletes the resources of CSIPFromToHeaderBase.
IMPORT_C TBool�	operator== (const CSIPFromToHeaderBase &aHeader) const
�	Compares this instance to another "From" or "To" header object.
IMPORT_C void�	SetSIPAddressL (CSIPAddress *aSIPAddress)
�	Sets the name-address.
IMPORT_C const CSIPAddress &�	SIPAddress () const
�	Gets the name-address as const.
IMPORT_C CSIPAddress &�	SIPAddress ()
�	Gets the name-address.
TBool�	HasCompactName () const
TPreferredPlace�	PreferredPlaceInMessage () const
Protected Member Functions
�	CSIPFromToHeaderBase ()
void�	ConstructL ()
void�	ConstructL (CSIPAddress *aSIPAddress)
void�	ConstructL (CSIPAddress *aSIPAddress, const TDesC8 &aTag)
void�	ConstructL (const CSIPFromToHeaderBase &aSIPFromToHeaderBase)
void�	DoInternalizeValueL (RReadStream &aReadStream)

Constructor & Destructor Documentation

virtual IMPORT_C CSIPFromToHeaderBase::~CSIPFromToHeaderBase (� �)� [virtual]

�	Destructor, deletes the resources of CSIPFromToHeaderBase.

CSIPFromToHeaderBase::CSIPFromToHeaderBase (� �)� [protected]

�

Member Function Documentation

void CSIPFromToHeaderBase::ConstructL (� const CSIPFromToHeaderBase &� aSIPFromToHeaderBase �)� [protected]

�

void CSIPFromToHeaderBase::ConstructL	(�	CSIPAddress *�	aSIPAddress,
		const TDesC8 &�	aTag
	)�	`[protected]`

�

void CSIPFromToHeaderBase::ConstructL (� CSIPAddress *� aSIPAddress �)� [protected]

�

void CSIPFromToHeaderBase::ConstructL (� �)� [protected]

�

void CSIPFromToHeaderBase::DoInternalizeValueL (� RReadStream &� aReadStream �)� [protected]

�

TBool CSIPFromToHeaderBase::HasCompactName (� �)� const [virtual]

�	Reimplemented from CSIPHeaderBase.

IMPORT_C TBool CSIPFromToHeaderBase::operator==

(�

const CSIPFromToHeaderBase &�

Compares this instance to another "From" or "To" header object.

Parameters:

aHeader�

a header to compare to

Returns:: ETrue, if the objects are equal otherwise EFalse

TPreferredPlace CSIPFromToHeaderBase::PreferredPlaceInMessage (� �)� const [virtual]

�	Implements CSIPHeaderBase.

IMPORT_C void CSIPFromToHeaderBase::SetSIPAddressL

Sets the name-address.

Precondition:: aSIPAddress != 0

Parameters:

aSIPAddress�

a name-address to set, the ownership is transferred

IMPORT_C CSIPAddress& CSIPFromToHeaderBase::SIPAddress

(�

�)�

�	Gets the name-address. Returns: name-address object

IMPORT_C const CSIPAddress& CSIPFromToHeaderBase::SIPAddress

(�

�)�