Class CSIPParameterHeaderBase

class CSIPParameterHeaderBase : public CSIPHeaderBase;

Description

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

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"

Members

Defined in CSIPParameterHeaderBase:
DeleteParam(), HasParam(), Param(), ParamCount(), ParamValue(), SetParamL(), SetParamL(), ToTextValueL(), ~CSIPParameterHeaderBase()

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

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

virtual IMPORT_C ~CSIPParameterHeaderBase();

Description

Destructor, deletes the resources of CSIPParameterHeaderBase.

IMPORT_C TBool HasParam(RStringF aName) const;

Description

Checks if a parameter is present

Parameters

RStringF aName the name of the parameter

Return value

TBool ETrue if present, otherwise EFalse

IMPORT_C RStringF ParamValue(RStringF aName) const;

Pre-Condition

HasParam(aName) == ETrue

Description

Gets a parameter value

Parameters

RStringF aName the name of the parameter

Return value

RStringF the parameter value if present, otherwise a zero-length length value.

IMPORT_C void SetParamL(RStringF aName, RStringF aValue);

Pre-Condition

HasParam(aName) == EFalse

Description

Sets a parameter with a value. Takes copies of the name and value, so if the RStringFs have been dynamically allocated, they can be closed if necessary after the function returns.

Parameters

RStringF aName the name of the parameter RStringF aValue the parameter value to set

IMPORT_C void SetParamL(RStringF aName);

Pre-Condition

HasParam(aName) == EFalse

Description

Sets a parameter without a value Takes copy of the name, so if the RStringF has been dynamically allocated, it can be closed if necessary after the function returns.

Parameters

RStringF aName the parameter name to set

IMPORT_C void DeleteParam(RStringF aName);

Description

Deletes a parameter

Parameters

RStringF aName the parameter name to delete

IMPORT_C TInt ParamCount() const;

Description

Gets the count of header parameters

Return value

TInt count of header parameters

IMPORT_C TInt Param(TInt aIndex, RStringF &aName) const;

Description

Gets a header parameter name by index. This function can be used when looping through all the header parameters.

Parameters

TInt aIndex the index of the parameter RStringF &aName copy of the parameter name that must be closed by the caller.

Return value

TInt KErrNotFound if aIndex is invalid. Otherwise EFalse.

virtual IMPORT_C HBufC8 *ToTextValueL() const;

Description

From CSIPHeaderBase ToTextValueL

Return value

HBufC8 *