UriUtils Class Reference

#include <uriutils.h>

class UriUtils

Public Member Enumerations
enum	TUriHostType { EIPv6Host, EIPv4Host, ETextHost }

Public Member Functions
IMPORT_C CUri16 *	ConvertToDisplayFormL(const TUriC8 &)
IMPORT_C CUri8 *	ConvertToInternetFormL(const TUriC16 &)
IMPORT_C CAuthority8 *	CreateAuthorityL(const TDesC &)
IMPORT_C CUri8 *	CreateUriL(const TDesC &)
IMPORT_C TBool	HasInvalidChars(const TDesC8 &)
IMPORT_C TBool	HasInvalidChars(const TDesC16 &)
IMPORT_C TUriHostType	HostType(const TDesC8 &)
IMPORT_C TUriHostType	HostType(const TDesC16 &)
IMPORT_C CUri8 *	NormaliseUriL(const TUriC8 &)

Detailed Description

Comments :

Member Enumeration Documentation

Enum TUriHostType

Enum defining a flag used to indicate host type.

Since: 9.1

Enumerator	Value	Description
EIPv6Host		Indicates host is of type IPv6. Example: 1080:0:0:0:8:800:200C:417A
EIPv4Host		Indicates host is of type IPv4. Example: 192.168.202.18
ETextHost		Indicates host is in text form. Example: www.mypage.com

Member Function Documentation

ConvertToDisplayFormL ( const TUriC8 & )

IMPORT_C CUri16 *

ConvertToDisplayFormL

(

const TUriC8 &

aUri

)

[static]

Converts an 8-bit format uri its into display form. Any escape tripes are decoded and sets of Utf8 format characters are converted into Unicode.

DeprecatedDeprecated in 9.1

Since: 6.0

Parameters
aUri	The 8-bit format uri.

Return Value: A pointer to a newly created 16-bit uri.

Leave Codes
KUriUtilsCannotConvert.	When the input data cannot be converted.

ConvertToInternetFormL ( const TUriC16 & )

IMPORT_C CUri8 *

ConvertToInternetFormL

(

const TUriC16 &

aUri

)

[static]

Converts a 16-bit format uri into its internet form. Any Unicode characters are converted into Utf8 representation and then any excluded characters are escape encoded. Reserved characters specified in RFC2396 will not be escape encoded however, these include ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" | "$" | ",". For example http://localhost will not be encoded to http%3A%2F%2Flocalhost.

DeprecatedDeprecated in 9.1

Since: 6.0

Parameters
aUri	The 16-bit format uri.

Return Value: A pointer to a newly created 8-bit uri.

Leave Codes
KUriUtilsCannotConvert.	When the input data cannot be converted.
KUriUtilsErr16BitChar.	When the input data has a 16-Bit character to be escape encoded.

CreateAuthorityL ( const TDesC & )

IMPORT_C CAuthority8 *

CreateAuthorityL

(

const TDesC &

aAuthority

)

[static]

Create a new CAuthority8 object from a Unicode descriptor.

Parameters
aAuthority	a Unicode string containing the Authority to parse.

Return Value: the new CAuthority8 object

Leave Codes
EUriUtilsParserErrInvalidUri	if the descriptor is an invalid Authority.

CreateUriL ( const TDesC & )

IMPORT_C CUri8 *

CreateUriL

(

const TDesC &

aUri

)

[static]

Create a new CUri8 object from a Unicode descriptor.

Parameters
aUri	a Unicode string containing the URI to parse.

Return Value: the new CUri8 object

Leave Codes
EUriUtilsParserErrInvalidUri	if the descriptor is an invalid URI.

HasInvalidChars ( const TDesC8 & )

IMPORT_C TBool

HasInvalidChars

(

const TDesC8 &

aData

)

[static]

Checks a descriptor for excluded (invalid) characters. Excluded characters include all control characters (values 0x00 to 0x1F and greater than 0x7F), space (0x20), delimiter characters ('<', '>', '#', '', '"') and unwise characters ('{', '}', '|', '\', '^', '[', ']', '`').

Since: 6.0

Parameters
aData	The descriptor to be checked.

Return Value: A boolean value of ETrue if the descriptor contains invalid characters, otherwise EFalse.

HasInvalidChars ( const TDesC16 & )

IMPORT_C TBool

HasInvalidChars

(

const TDesC16 &

aData

)

[static]

Checks a descriptor for excluded (invalid) characters. Excluded characters include all control characters (values 0x00 to 0x1F and greater than 0x7F), space (0x20), delimiter characters ('<', '>', '#', '','"') and unwise characters ('{', '}', '|', '\', '^', '[', ']', '`').

Since: 6.0

Parameters
aData	The descriptor to be checked.

Return Value: A boolean value of ETrue if the descriptor contains invalid characters, otherwise EFalse.

HostType ( const TDesC8 & )

IMPORT_C TUriHostType

HostType

(

const TDesC8 &

aHost

)

[static]

Checks the supplied host for an IPv4, IPv6 or text format host

Since: 7.0

Parameters
aHost	The descriptor containing the host to check

Return Value: A TUriHostType enum of either EIPv6, EIPv4, EText or EUnknown

HostType ( const TDesC16 & )

IMPORT_C TUriHostType

HostType

(

const TDesC16 &

aHost

)

[static]

Checks the supplied host for an IPv4, IPv6 or text format host

Since: 7.0

Parameters
aHost	The descriptor containing the host to check

Return Value: A TUriHostType enum of either EIPv6, EIPv4, EText or EUnknown

NormaliseUriL ( const TUriC8 & )

IMPORT_C CUri8 *

NormaliseUriL

(

const TUriC8 &

aUri

)

[static]

Supports Syntax-Based Normalization as specifed in section 6.2.2 of RFC3986. returns a new CUri8 object containing a normalised URI from a parsed URI object.

Parameters
aUri	A reference to a parsed uri object.

Return Value: A pointer to a CUri8 object containing normalised URI.

Leave Codes
KErrNoMemory