Collapse all Symbian^3 Product Developer Library

CUpnpArgument Class Reference

class CUpnpArgument : public CBase

Used to make a common body for actions. This class is only used when an action is sent or received. This class makes a common body for actions, which can then be modified by user.

Since: Series60 2.6

Inherits from

CUpnpArgument
- CBase

Public Member Functions
	~CUpnpArgument()
void	ConstructL()
IMPORT_C TInt	Direction()
IMPORT_C TDesC8 &	Name()
CUpnpArgument *	NewL(CUpnpService &)
CUpnpArgument *	NewL(CUpnpArgument &, CUpnpService &)
IMPORT_C TDesC8 &	RelatedStateVariable()
void	SetDirectionL(TInt)
void	SetNameL(const TDesC8 &)
void	SetRelatedStateVarL(const TDesC8 &)
void	SetType(TInt)
IMPORT_C void	SetValueL(const TDesC8 &)
IMPORT_C TArgumentType	Type()
IMPORT_C TDesC8 &	Value()

Private Member Functions
	CUpnpArgument(CUpnpService &)
void	CheckErrorL(TInt, const TDesC8 &)
void	ConstructL(CUpnpArgument &)
void	DeleteAndNullValue()

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
TInt	iDirection
HBufC8 *	iName
CUpnpService &	iParentService
HBufC8 *	iRelatedStateVariable
TInt	iType
HBufC8 *	iValue

Constructor & Destructor Documentation

CUpnpArgument(CUpnpService &)

CUpnpArgument

(

CUpnpService &

aParentService

)

[private]

C++ default constructor.

Parameters

CUpnpService & aParentService

Parent service.

~CUpnpArgument()

~CUpnpArgument

(

)

[virtual]

Destructor.

Member Functions Documentation

CheckErrorL(TInt, const TDesC8 &)

void	CheckErrorL	(	TInt	aError,
			const TDesC8 &	aValue
		)	[private]

Checks the error code for the SetValue method and leaves if needed.

Parameters

TInt aError
const TDesC8 & aValue

ConstructL()

void

ConstructL

(

)

ConstructL(CUpnpArgument &)

void

ConstructL

(

CUpnpArgument &

aArgument

)

[private]

By default Symbian 2nd phase constructor is private. Adds the arguments and their default values according to the XML node

Parameters

CUpnpArgument & aArgument

DeleteAndNullValue()

void

DeleteAndNullValue

(

)

[private]

Delete and null iValue member.

Direction()

IMPORT_C TInt

Direction

(

)

const

Returns direction of the argument.

Since: Series60 2.6

Name()

IMPORT_C TDesC8 &

Name

(

)

Returns the name of the argument.

Since: Series60 2.6

NewL(CUpnpService &)

CUpnpArgument *

NewL

(

CUpnpService &

aParentService

)

[static]

Parameters

CUpnpService & aParentService

NewL(CUpnpArgument &, CUpnpService &)

CUpnpArgument *	NewL	(	CUpnpArgument &	aArgument,
			CUpnpService &	aParentService
		)	[static]

Two-phased constructor for building from a XML node. Internally uses the function NewL(CSereneElement*)

Parameters

CUpnpArgument & aArgument
CUpnpService & aParentService

RelatedStateVariable()

IMPORT_C TDesC8 &

RelatedStateVariable

(

)

Returns related state variable.

Since: Series60 2.6

SetDirectionL(TInt)

void

SetDirectionL

(

TInt

aDirection

)

Parameters

TInt aDirection

SetNameL(const TDesC8 &)

void

SetNameL

(

const TDesC8 &

aDirection

)

Parameters

const TDesC8 & aDirection

SetRelatedStateVarL(const TDesC8 &)

void

SetRelatedStateVarL

(

const TDesC8 &

aRelatedStateVar

)

Parameters

const TDesC8 & aRelatedStateVar

SetType(TInt)

void

SetType

(

TInt

aType

)

Parameters

TInt aType

SetValueL(const TDesC8 &)

IMPORT_C void

SetValueL

(

const TDesC8 &

aValue

)

Sets the value of argument.

Since: Series60 2.6 (If the value is inproper, the method leaves with EInvalidArgs, which is the internal upnp error code used by UPnP Stack)

Parameters

const TDesC8 & aValue

Value that is to be set for this argument.

Type()

IMPORT_C TArgumentType

Type

(

)

Returns type of the argument.

Since: Series60 2.6

Value()

IMPORT_C TDesC8 &

Value

(

)

Returns the value of the argument.

Since: Series60 2.6

Member Data Documentation

TInt iDirection

TInt

iDirection

[private]

HBufC8 * iName

HBufC8 *

iName

[private]

CUpnpService & iParentService

CUpnpService &

iParentService

[private]

HBufC8 * iRelatedStateVariable

HBufC8 *

iRelatedStateVariable

[private]

TInt iType

TInt

iType

[private]

HBufC8 * iValue

HBufC8 *

iValue

[private]