CMMFUrlParams Class Reference

#include <mmf/common/mmfcontrollerframeworkbase.h>

Link against: mmfcontrollerframework.lib

class CMMFUrlParams : public CBase

Inherits from

CMMFUrlParams

Public Member Functions
	~CMMFUrlParams()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C CBufFlat *	ExternalizeToCBufFlatLC()
IMPORT_C TInt	IAPId()
IMPORT_C CMMFUrlParams *	NewL(const TDesC &, TInt)
IMPORT_C CMMFUrlParams *	NewLC(const TDesC &, TInt)
IMPORT_C CMMFUrlParams *	NewLC(RReadStream &)
IMPORT_C const TDesC &	Url()
IMPORT_C TBool	UseIAPId()

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()

Detailed Description

Class to be used to configure a URL source or sink.

Contains a variable length string to represent the URL, and whether to use a specified Internet Access Point or use the default.

Since: 7.0s

Constructor & Destructor Documentation

~CMMFUrlParams ( )

~CMMFUrlParams

(

)

Destructor.

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalize this object to a stream.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameter	Description
aStream	The stream to which the object will be externalized.

ExternalizeToCBufFlatLC ( )

IMPORT_C CBufFlat *

ExternalizeToCBufFlatLC

(

)

const

Externalize this object into a newly created CBufFlat buffer.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Returns: The newly created buffer containing the externalized data. The CBufFlat object will be left on the cleanup stack.

IAPId ( )

IMPORT_C TInt

IAPId

(

)

const

Returns the Internet Access Point ID.

Since: 7.0s

Returns: IAP ID.

NewL ( const TDesC &, TInt )

IMPORT_C CMMFUrlParams *	NewL	(	const TDesC &	aUrl,
			TInt	aIAPId = KUseDefaultIap
		)	[static]

Factory function to create a CMMFUrlParams object.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameter	Description
aUrl	The url, for example http://www.symbian.com/clip.mpg
aIAPId	The Inernet Access Point to be used. This should be a valid IAP ID retrieved from CommDB. A special value of KUseDefaultIap can be used to signify that the plugin should just use the default IAP.

Returns: A pointer to the newly created object.

NewLC ( const TDesC &, TInt )

IMPORT_C CMMFUrlParams *	NewLC	(	const TDesC &	aUrl,
			TInt	aIAPId = KUseDefaultIap
		)	[static]

Factory function to create a CMMFUrlParams object.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameter	Description
aUrl	The url, for example http://www.symbian.com/clip.mpg
aIAPId	The Inernet Access Point to be used. This should be a valid IAP ID retrieved from CommDB. A special value of KUseDefaultIap can be used to signify that the plugin should just use the default IAP.

Returns: A pointer to the newly created object. The object will be left on the cleanup stack.

NewLC ( RReadStream & )

IMPORT_C CMMFUrlParams *

NewLC

(

RReadStream &

aStream

)

[static]

Factory function to create a CMMFUrlParams object by internalizing data from a stream.

This method can leave with one of the standard system-wide error codes.

Since: 7.0s

Parameter	Description
aStream	The stream from which the object should be internalized.

Returns: The newly created object. The object will be left on the cleanup stack.

Url ( )

IMPORT_C const TDesC &

Url

(

)

const

Returns the URL string, for example http://www.symbian.com/clip/mpg.

Since: 7.0s

Returns: The URL string.

UseIAPId ( )

IMPORT_C TBool

UseIAPId

(

)

const

Signifies whether the IAP ID should be used. This is determined internally by comparing the IAP ID with KUseDefaultIap.

Since: 7.0s

Returns: A boolean indicating if the IAP ID should be used. ETrue if the supplied IAPId should be used, EFalse if not.