Collapse all Symbian^3 Application Developer Library

CHeaderFieldPart Class Reference

class CHeaderFieldPart : public CBase

Generalised representation of a single HTTP header value part. The part takes a value of one of the following three types:

integer, signed (i.e. can be -ve or +ve)
string token, which can represent free text (i.e. text with no special meaning; ETags; MD5 hashes; MIME types, etc.), enumerations (words with special meanings such as 'private', 'close', ') or URLs
Date/Time

In addition the part may have one or more parameters. These take the form of attribute-value pairs. They are implemented by the CHeaderFieldParam class.

Inherits from

CHeaderFieldPart
- CBase

Public Member Functions
	~CHeaderFieldPart ()
TInt	AddParam ( CHeaderFieldParam *)
void	AddParamL ( CHeaderFieldParam *)
void	ClosePropertySet ( RHTTPPropertySet &)
CHeaderFieldPart *	New ( THTTPHdrVal )
CHeaderFieldPart *	NewL ( THTTPHdrVal )
TInt	NumParameters ()
CHeaderFieldParam *	Parameter ( TInt )
CHeaderFieldParam *	Parameter ( RStringF )
THeaderFieldParamIter	Parameters ()
TInt	RemoveParam ( CHeaderFieldParam *)
void	SetPropertySet ( RHTTPPropertySet &)
void	SetValue ( THTTPHdrVal )
THTTPHdrVal	Value ()

Private Member Functions
	CHeaderFieldPart ( THTTPHdrVal )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
RPointerArray < CHeaderFieldParam >	iParams
THTTPHdrVal	iValue

Constructor & Destructor Documentation

CHeaderFieldPart(THTTPHdrVal)

CHeaderFieldPart

(

THTTPHdrVal

aVal

)

[private, inline]

Parameters

THTTPHdrVal aVal

~CHeaderFieldPart()

~CHeaderFieldPart

(

)

[inline]

Member Functions Documentation

AddParam(CHeaderFieldParam *)

TInt

AddParam

(

CHeaderFieldParam *

aParam

)

[inline]

Parameters

CHeaderFieldParam * aParam

AddParamL(CHeaderFieldParam *)

void

AddParamL

(

CHeaderFieldParam *

aParam

)

[inline]

Add a parameter to the header part. It is appended after any existing parameters.

Parameters

CHeaderFieldParam * aParam

The parameter to be added. The header takes ownership of the new parameter.

ClosePropertySet(RHTTPPropertySet &)

void

ClosePropertySet

(

RHTTPPropertySet &

aPropertySet

)

[static, inline]

Parameters

RHTTPPropertySet & aPropertySet

New(THTTPHdrVal)

CHeaderFieldPart *

New

(

THTTPHdrVal

aVal

)

[static, inline]

Parameters

THTTPHdrVal aVal

NewL(THTTPHdrVal)

CHeaderFieldPart *

NewL

(

THTTPHdrVal

aVal

)

[static, inline]

Create a new part, for the supplied HTTP value

Parameters

THTTPHdrVal aVal

The HTTP value for this part of the header field. A copy is taken when storing.

NumParameters()

TInt

NumParameters

(

)

const [inline]

Obtain the number of parameters in this header

Parameter(TInt)

CHeaderFieldParam *

Parameter

(

TInt

aIndex

)

const [inline]

Access the header parameters by index

Parameters

TInt aIndex

The index of the desired parameter. 0 references the first one.

Parameter(RStringF)

CHeaderFieldParam *

Parameter

(

RStringF

aParamName

)

const

Access the header parameters by parameter name Implementation of CHeaderFieldPart class ************************************************* Getter's

Parameters

RStringF aParamName

The name of the desired part.

Parameters()

THeaderFieldParamIter

Parameters

(

)

const [inline]

Access the parameters in this header part via an iterator

RemoveParam(CHeaderFieldParam *)

TInt

RemoveParam

(

CHeaderFieldParam *

aParam

)

Remove the specified parameter from the header part.

Parameters

CHeaderFieldParam * aParam

The parameter to be removed. The header deletes the removed parameter.

SetPropertySet(RHTTPPropertySet &)

void

SetPropertySet

(

RHTTPPropertySet &

aPropertySet

)

[inline]

Parameters

RHTTPPropertySet & aPropertySet

SetValue(THTTPHdrVal)

void

SetValue

(

THTTPHdrVal

aVal

)

Change the value held in this field part Setter's

Parameters

THTTPHdrVal aVal

Value()

THTTPHdrVal

Value

(

)

const [inline]

Obtain the value held in this field part. The caller must call Copy() on the returned THTTPHdrVal if it is going to be stored. This is needed in order to correctly maintain string references.

Member Data Documentation

RPointerArray< CHeaderFieldParam > iParams

RPointerArray < CHeaderFieldParam >

iParams

[private]

THTTPHdrVal iValue

THTTPHdrVal

iValue

[private]