Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <mmfcontrollerframeworkbase.h>
Link against: mmfcontrollerframework.lib

Class CMMFUrlParams

class CMMFUrlParams : public CBase;

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.

Derivation

Members

Defined in CMMFUrlParams:

Inherited from CBase:


Construction and destruction


NewL(const TDesC &,TInt)

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

Description

Factory function to create a CMMFUrlParams object.

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

Parameters

const TDesC16 &aUrl

The url, for example

TInt 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.

Return value

CMMFUrlParams *

A pointer to the newly created object.


NewLC(const TDesC &,TInt)

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

Description

Factory function to create a CMMFUrlParams object.

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

Parameters

const TDesC16 &aUrl

The url, for example

TInt 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.

Return value

CMMFUrlParams *

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


NewLC(RReadStream &)

IMPORT_C static CMMFUrlParams* NewLC(RReadStream &aStream);

Description

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.

Parameters

RReadStream &aStream

The stream from which the object should be internalized.

Return value

CMMFUrlParams *

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

[Top]


Member functions


ExternalizeL(RWriteStream &)const

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalize this object to a stream.

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

Parameters

RWriteStream &aStream

The stream to which the object will be externalized.


ExternalizeToCBufFlatLC()const

IMPORT_C CBufFlat* ExternalizeToCBufFlatLC() const;

Description

Externalize this object into a newly created CBufFlat buffer.

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

Return value

CBufFlat *

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


Url()const

IMPORT_C const TDesC& Url() const;

Description

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

Return value

const TDesC16 &

The URL string.


IAPId()const

IMPORT_C TInt IAPId() const;

Description

Returns the Internet Access Point ID.

Return value

TInt

IAP ID.


UseIAPId()const

IMPORT_C TBool UseIAPId() const;

Description

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

Return value

TBool

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