Class CUri16

class CUri16 : public CBase;

Description

Dependencies : CBase, TUriC16. Comments : Provides modifying functionality on the components of a uri object, as defined in RFC2396. There are 5 components; scheme. authority, path, query and fragment.

The object holds parsed uri information. It is owning. It uses 16-bit descriptors.

The functionality provided by this API allows the uri components to be set or removed from this parsed uri. Also, it provides a reference to TUriC16 object so that the non-modifying functionality can be used.

Derivation

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

• CUri16 - Dependencies : CBase, TUriC16

Members

Defined in CUri16:
CreateFileUriL(), CreatePrivateFileUriL(), NewL(), NewL(), NewLC(), NewLC(), RemoveComponentL(), ResolveL(), SetComponentL(), Uri(), ~CUri16()

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

static IMPORT_C CUri16 *NewL(const TUriC16 &aUri);

Description

Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack. Creates a uri object which is a copy of the input parameter aUri.

Post-Condition

A fully constructed and initialized CUri16 object.

Parameters

const TUriC16 &aUri A reference to a parsed uri object.

Return value

CUri16 * A pointer to the newly created CUri16 object.

static IMPORT_C CUri16 *NewLC(const TUriC16 &aUri);

Description

Static factory constructor. Uses two phase construction and leaves a pointer to created object on the CleanupStack. Creates a uri object which is a copy of the input parameter aUri.

Post-Condition

A fully constructed and initialized CUri16 object.

Parameters

const TUriC16 &aUri A reference to a parsed uri object.

Return value

CUri16 * A pointer to the newly created CUri16 object.

static IMPORT_C CUri16 *NewL();

Description

Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack. Creates a uri object which is empty.

Post-Condition

A fully constructed and initialized CUri16 object.

Return value

CUri16 * A pointer to the newly created CUri16 object.

static IMPORT_C CUri16 *NewLC();

Description

Static factory constructor. Uses two phase construction and leaves a pointer to created object on the CleanupStack. Creates a uri object which is empty.

Post-Condition

A fully constructed and initialized CUri16 object.

Return value

CUri16 * A pointer to the newly created CUri16 object.

IMPORT_C ~CUri16();

Description

Destructor.

static IMPORT_C CUri16 *CreateFileUriL(const TDesC &aFullFileName, TUint aFlags=0);

Description

Allocates and constructs a file URI object for a specified file.

• If the file exists on a fixed drive, then the file URI takes the form: 'file:///<drive-letter>/<filepath including filename>'.

• If the file exists on a removable media drive, then the file URI takes the form: 'file:///ext-media/<filepath including filename>'.

Post-Condition

A fully constructed and initialized file URI (CUri16) object.

Parameters

const TDesC &aFullFileName A reference to a fully qualified filename TUint aFlags A flag to indicate if the file exists on a fixed drive or removable media drive. This is a TFileUriFlags value.

Return value

CUri16 * A pointer to the newly created file URI (CUri16) object.

static IMPORT_C CUri16 *CreatePrivateFileUriL(const TDesC &aRelativeFileName, TDriveNumber aDrive, TInt aFlags=0);

Description

Allocates and constructs a file URI object for a file that is private to the application.

• If the file exists on a fixed drive, then the file URI takes the form 'file:///private/<drive-letter>/<filepath including filename>'.

• If the file exists on a removable media drive, then the file URI takes the form 'file:///private/ext-media/<filepath including filename>'.

Post-Condition

A fully constructed and initialized file URI (CUri16) object.

Parameters

const TDesC &aRelativeFileName A reference to the filename relative to the application's private directory. TDriveNumber aDrive Drive number, if the private file stored on fixed drive, otherwise not used This is a TDriveNumber value TInt aFlags A flag to indicate if the file exists on a fixed drive or removable media drive. This is a TFileUriFlags value.

Return value

CUri16 * A pointer to the newly created file URI (CUri16) object.

static IMPORT_C CUri16 *ResolveL(const TUriC16 &aBaseUri, const TUriC16 &aRefUri);

Pre-Condition

The base uri must have an absolute or empty path, otherwise will leave with KUriErrBadBasePath.

Description

Static factory constructor. This creates a CUri16 object that is an absolute uri resulting from a reference uri being resolved against a base uri.

Post-Condition

A fully constructed and initialized CUri16 object.

Parameters

const TUriC16 &aBaseUri A referece to the parsed base uri. const TUriC16 &aRefUri A referece to the parsed reference uri.

Return value

CUri16 * A pointer to the newly created CUri16 object.

Leave codes

KUriErrBadBasePath if the base path is not an absolute path and not empty.

IMPORT_C const TUriC16 &Uri() const;

Description

Provides a reference to the parsed uri. Allows access to the non-modifying API for TUriC16.

Return value

const TUriC16 & A const reference to the parsed uri object.

IMPORT_C void SetComponentL(const TDesC16 &aData, TUriComponent aComponent);

Pre-Condition

Object is fully constructed.

Description

Sets the specified component in the uri. The component is set to the value given in the argument aData. If the specified component already exists then it is replaced with the new value.

Post-Condition

The uri has the specified component set to the new value.

Parameters

const TDesC16 &aData A descriptor pointer to the new value for the uri component. TUriComponent aComponent An enum specifying the component to be set.

IMPORT_C void RemoveComponentL(TUriComponent aComponent);

Pre-Condition

Object is fully constructed.

Description

Removes the specified component from the uri. If the component does not exist then this function does nothing.

Post-Condition

The uri is updated to exclude the specified component.

Parameters

TUriComponent aComponent An enum specifying the component to be removed.