Class CSIPFromToHeaderBase

class CSIPFromToHeaderBase : public CSIPParameterHeaderBase;

Description

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

This is an abstract class and cannot be instantiated.

sipcodec.lib

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPHeaderBase - Class provides a generic interface for all the SIP headers

• CSIPParameterHeaderBase - A base class for SIP headers that have structure "mandatory part"delimiter"parameters"

• CSIPFromToHeaderBase - Class provides functions for setting and getting parameters in SIP "From" and "To" header

Members

Defined in CSIPFromToHeaderBase:
SIPAddress(), SIPAddress(), SetSIPAddressL(), operator==(), ~CSIPFromToHeaderBase()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSIPHeaderBase:
CloneL(), ExternalizeL(), ExternalizeSupported(), Name(), PushLC(), ToTextL(), ToTextLC(), ToTextValueLC()

Inherited from CSIPParameterHeaderBase:
DeleteParam(), HasParam(), Param(), ParamCount(), ParamValue(), SetParamL(), ToTextValueL()

virtual IMPORT_C ~CSIPFromToHeaderBase();

Description

Destructor, deletes the resources of CSIPFromToHeaderBase.

IMPORT_C TBool operator==(const CSIPFromToHeaderBase &aHeader) const;

Description

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

Parameters

const CSIPFromToHeaderBase &aHeader a header to compare to

Return value

TBool ETrue, if the objects are equal otherwise EFalse

IMPORT_C void SetSIPAddressL(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

Description

Sets the name-address

Parameters

CSIPAddress *aSIPAddress a name-address to set, the ownership is transferred

IMPORT_C const CSIPAddress &SIPAddress() const;

Description

Gets the name-address as const

Return value

const CSIPAddress & name-address object

IMPORT_C CSIPAddress &SIPAddress();

Description

Gets the name-address

Return value

CSIPAddress & name-address object