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

• CBase - Base class for all classes to be instantiated on the heap

• CMMFUrlParams - Class to be used to configure a URL source or sink

Members

Defined in CMMFUrlParams:
ExternalizeL(), ExternalizeToCBufFlatLC(), IAPId(), NewL(), NewLC(), NewLC(), Url(), UseIAPId()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C 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 TDesC &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.

static IMPORT_C 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 TDesC &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.

static IMPORT_C 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.

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.

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.

IMPORT_C const TDesC &Url() const;

Description

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

Return value

const TDesC & The URL string.

IMPORT_C TInt IAPId() const;

Description

Returns the Internet Access Point ID.

Return value

TInt IAP ID.

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.