Symbian^3 Application Developer Library >

CUpnpElement Class Reference

class CUpnpElement : public CBase

UPnPContainer interface

upnpavobjects.lib
Since
Series 60 3.0

Inherits from

Public Member Functions
~CUpnpElement ()
IMPORT_C void AddAttributeL ( CUpnpAttribute *)
IMPORT_C void CopyL (const CUpnpElement &)
IMPORT_C void ExternalizeL ( RWriteStream &)
IMPORT_C const TDesC & FilePath ()
IMPORT_C const RUPnPAttributesArray & GetAttributes ()
IMPORT_C void InternalizeL ( RReadStream &)
IMPORT_C TBool IsRequired ()
IMPORT_C const TDesC8 & Name ()
IMPORT_C CUpnpElement * NewL (const TDesC8 &)
IMPORT_C CUpnpElement * NewLC (const TDesC8 &)
IMPORT_C void RemoveAttributeL (const CUpnpAttribute *)
IMPORT_C void SetFilePathL (const TDesC &)
IMPORT_C void SetIsRequired ( TBool )
IMPORT_C void SetNameL (const TDesC8 &)
IMPORT_C void SetValueL (const TDesC8 &)
IMPORT_C const TDesC8 & Value ()
Private Member Functions
CUpnpElement ()
void ConstructL (const TDesC8 &)
TInt MapItemNameToProperLength ( TDesC8 &)
void SafeExternalize16L ( RWriteStream &, const TDesC &, const TInt )
void SafeExternalizeL ( RWriteStream &, const TDesC8 &, const TInt )
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
RUPnPAttributesArray iAttributes
HBufC8 * iElementName
HBufC8 * iElementValue
HBufC * iFilePath
TBool iIsRequired

Constructor & Destructor Documentation

CUpnpElement()

CUpnpElement ( ) [private]

C++ default constructor.

~CUpnpElement()

~CUpnpElement ( ) [virtual]

Destructor.

Member Functions Documentation

AddAttributeL(CUpnpAttribute *)

IMPORT_C void AddAttributeL ( CUpnpAttribute * aNewAttribute )
Adds Attribute for the UPnP Object
Since
Series 60 3.0

Parameters

CUpnpAttribute * aNewAttribute

ConstructL(const TDesC8 &)

void ConstructL ( const TDesC8 & aName ) [private]

By default Symbian 2nd phase constructor is private.

Parameters

const TDesC8 & aName

CopyL(const CUpnpElement &)

IMPORT_C void CopyL ( const CUpnpElement & aElement )
Copies contents from CUpnpElement given as parameter to this object. Leaves in case of errors.
Since
Series 60 3.0

Parameters

const CUpnpElement & aElement

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aStream ) const
Externalizes element information to stream. Leaves in case of errors.
Since
Series 60 3.0

Parameters

RWriteStream & aStream

FilePath()

IMPORT_C const TDesC & FilePath ( ) const
Gets path for the UPnP element res
Since
Series 60 3.0

GetAttributes()

IMPORT_C const RUPnPAttributesArray & GetAttributes ( )
Gets Attribute array of the object
Since
Series 60 3.0

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream )
Internalizes element information from stream. Leaves in case of errors.
Since
Series 60 3.0

Parameters

RReadStream & aStream

IsRequired()

IMPORT_C TBool IsRequired ( ) const

MapItemNameToProperLength(TDesC8 &)

TInt MapItemNameToProperLength ( TDesC8 & aItemName ) const [private]

Parameters

TDesC8 & aItemName

Name()

IMPORT_C const TDesC8 & Name ( ) const
Gets name for the UPnP element
Since
Series 60 3.0

NewL(const TDesC8 &)

IMPORT_C CUpnpElement * NewL ( const TDesC8 & aName =  KNullDesC8 () ) [static]

Parameters

const TDesC8 & aName =  KNullDesC8 ()

NewLC(const TDesC8 &)

IMPORT_C CUpnpElement * NewLC ( const TDesC8 & aName =  KNullDesC8 () ) [static]

Two-phased constructor.

Parameters

const TDesC8 & aName =  KNullDesC8 ()

RemoveAttributeL(const CUpnpAttribute *)

IMPORT_C void RemoveAttributeL ( const CUpnpAttribute * aNewAttribute )
Removes specified Attribute from the UPnP Object
Since
Series 60 3.0

Parameters

const CUpnpAttribute * aNewAttribute

SafeExternalize16L(RWriteStream &, const TDesC &, const TInt)

void SafeExternalize16L ( RWriteStream & aStream,
const TDesC & aDesc,
const TInt aNumber
) const [private]

Parameters

RWriteStream & aStream
const TDesC & aDesc
const TInt aNumber

SafeExternalizeL(RWriteStream &, const TDesC8 &, const TInt)

void SafeExternalizeL ( RWriteStream & aStream,
const TDesC8 & aDesc,
const TInt aNumber
) const [private]
Safely externalizes element information to stream. Leaves in case of errors.
Since
Series 60 3.0

Parameters

RWriteStream & aStream
const TDesC8 & aDesc
const TInt aNumber

SetFilePathL(const TDesC &)

IMPORT_C void SetFilePathL ( const TDesC & aFilePath )
SetFilePathL path for the UPnP element res
Since
Series 60 3.0

Parameters

const TDesC & aFilePath

SetIsRequired(TBool)

IMPORT_C void SetIsRequired ( TBool aIsRequired )

Parameters

TBool aIsRequired

SetNameL(const TDesC8 &)

IMPORT_C void SetNameL ( const TDesC8 & aName )
Sets name for the UPnP element. Leaves in case of errors.
Since
Series 60 3.0

Parameters

const TDesC8 & aName

SetValueL(const TDesC8 &)

IMPORT_C void SetValueL ( const TDesC8 & aValue )
Sets value for the UPnP element. Leaves in case of errors.
Since
Series 60 3.0

Parameters

const TDesC8 & aValue

Value()

IMPORT_C const TDesC8 & Value ( ) const
Gets value for the UPnP element
Since
Series 60 3.0

Member Data Documentation

RUPnPAttributesArray iAttributes

RUPnPAttributesArray iAttributes [private]

HBufC8 * iElementName

HBufC8 * iElementName [private]

HBufC8 * iElementValue

HBufC8 * iElementValue [private]

HBufC * iFilePath

HBufC * iFilePath [private]

TBool iIsRequired

TBool iIsRequired [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.