Collapse all Symbian^3 Application Developer Library

CSPEntry Class Reference

class CSPEntry : public CBase

Service Provider Settings entry. Container class for service attributes and settings properties

serviceprovidersettings.lib

Since: S60 V3.2

Inherits from

CSPEntry
- CBase

Public Member Functions
	~CSPEntry ()
IMPORT_C TInt	AddPropertyL (const CSPProperty &)
IMPORT_C TInt	DeleteProperty ( TInt )
IMPORT_C TInt	DeleteProperty ( TServicePropertyName )
IMPORT_C const RPropertyArray &	GetAllProperties ()
IMPORT_C TInt	GetProperty (const CSPProperty *&, TServicePropertyName )
IMPORT_C TInt	GetProperty (const CSPProperty *&, TInt )
IMPORT_C TServiceId	GetServiceId ()
IMPORT_C const TDesC &	GetServiceName ()
IMPORT_C CSPEntry *	NewL ()
IMPORT_C CSPEntry *	NewLC ()
IMPORT_C TInt	PropertyCount ()
IMPORT_C void	Reset ()
void	SetServiceId ( TServiceId )
IMPORT_C TInt	SetServiceName (const TDesC &)
IMPORT_C TInt	UpdateProperty ( TServicePropertyName , TInt )
IMPORT_C TInt	UpdateProperty ( TServicePropertyName , const TDesC &)
IMPORT_C TInt	UpdateProperty ( TServicePropertyName , TOnOff )

Private Member Functions
	CSPEntry ()
void	ConstructL ()
TInt	SearchProperty ( TServicePropertyName )

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
RPropertyArray	iPropertyArray
TServiceId	iServiceId
RBuf	iServiceName

Constructor & Destructor Documentation

CSPEntry()

CSPEntry

(

)

[private]

C++ default constructor.

~CSPEntry()

IMPORT_C

~CSPEntry

(

)

[virtual]

Destructors.

Member Functions Documentation

AddPropertyL(const CSPProperty &)

IMPORT_C TInt

AddPropertyL

(

const CSPProperty &

aProperty

)

Adds new property to this entry.

Since: S60 V3.2

Parameters

const CSPProperty & aProperty

new property pointer

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

DeleteProperty(TInt)

IMPORT_C TInt

DeleteProperty

(

TInt

aIndex

)

Deletes property from this entry by index.

Since: S60 V3.2

Parameters

TInt aIndex

index of requested property

DeleteProperty(TServicePropertyName)

IMPORT_C TInt

DeleteProperty

(

TServicePropertyName

aProperty

)

Deletes property from this entry by property name.

Since: S60 V3.2

Parameters

TServicePropertyName aProperty

property name

GetAllProperties()

IMPORT_C const RPropertyArray &

GetAllProperties

(

)

const

Returns all properties of this entry.

Since: S60 V3.2

GetProperty(const CSPProperty *&, TServicePropertyName)

IMPORT_C TInt	GetProperty	(	const CSPProperty *&	aProperty,
			TServicePropertyName	aPropertyName
		)	const

Returns property of this entry by property name.

Since: S60 V3.2

Parameters

const CSPProperty *& aProperty	On return, reference to requested property
TServicePropertyName aPropertyName	Name of requested property

GetProperty(const CSPProperty *&, TInt)

IMPORT_C TInt	GetProperty	(	const CSPProperty *&	aProperty,
			TInt	aIndex
		)	const

Returns property of this entry by property index.

Since: S60 V3.2

Parameters

const CSPProperty *& aProperty	On return, reference to requested property
TInt aIndex	index of requested property

GetServiceId()

IMPORT_C TServiceId

GetServiceId

(

)

const

Returns service Id of this entry.

Since: S60 V3.2

GetServiceName()

IMPORT_C const TDesC &

GetServiceName

(

)

const

Returns service name of this entry.

Since: S60 V3.2

NewL()

IMPORT_C CSPEntry *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CSPEntry *

NewLC

(

)

[static]

Two-phased constructor.

PropertyCount()

IMPORT_C TInt

PropertyCount

(

)

const

Returns count of properties in this entry

Since: S60 V3.2

Reset()

IMPORT_C void

Reset

(

)

reset service entry

Since: S60 V3.2

SearchProperty(TServicePropertyName)

TInt

SearchProperty

(

TServicePropertyName

aProperty

)

const [private]

Search index of requested property in iPropertyArray

Since: S60 ?S60_version

Parameters

TServicePropertyName aProperty

SetServiceId(TServiceId)

void

SetServiceId

(

TServiceId

aServiceId

)

Sets unique service provider ID for this entry. This ID is generated automatically when new entry is added. Service ID is also required when user updates entry in service table

Since: S60 V3.2

Parameters

TServiceId aServiceId

service ID

SetServiceName(const TDesC &)

IMPORT_C TInt

SetServiceName

(

const TDesC &

aServiceName

)

Sets service name for this entry.

Since: S60 V3.2

Parameters

const TDesC & aServiceName

service name

UpdateProperty(TServicePropertyName, TInt)

IMPORT_C TInt	UpdateProperty	(	TServicePropertyName	aPropertyName,
			TInt	aValue
		)

Updates content of property in this entry.

Since: S60 V3.2

Parameters

TServicePropertyName aPropertyName	property name
TInt aValue	new TInt value

UpdateProperty(TServicePropertyName, const TDesC &)

IMPORT_C TInt	UpdateProperty	(	TServicePropertyName	aPropertyName,
			const TDesC &	aValue
		)

Updates content of property in this entry.

Since: S60 V3.2

Parameters

TServicePropertyName aPropertyName	property name
const TDesC & aValue	new TDesC value

UpdateProperty(TServicePropertyName, TOnOff)

IMPORT_C TInt	UpdateProperty	(	TServicePropertyName	aPropertyName,
			TOnOff	aValue
		)

Updates content of property in this entry.

Since: S60 V3.2

Parameters

TServicePropertyName aPropertyName	property name
TOnOff aValue	new TOnOff value

Member Data Documentation

RPropertyArray iPropertyArray

RPropertyArray

iPropertyArray

[private]

Service settings properties owned by this entry Own.

TServiceId iServiceId

TServiceId

iServiceId

[private]

Id of service settings entry ( unique )

RBuf iServiceName

RBuf

iServiceName

[private]

Name of settings entry ( unique ) Own.