EscapeUtils Class Reference

class EscapeUtils

Comments : Provides an API to allow data to be escape encoded and decoded. Also provide an API for converting a UNICODE data (16-bit descriptor) into UTF8 data (8-bit descriptor) and vice-verse. 6.0

Public Member Functions
IMPORT_C HBufC8 *ConvertFromUnicodeToUtf8L(const TDesC &)
IMPORT_C HBufC *ConvertToUnicodeFromUtf8L(const TDesC8 &)
IMPORT_C HBufC8 *EscapeDecodeL(const TDesC8 &)
IMPORT_C HBufC16 *EscapeDecodeL(const TDesC16 &)
IMPORT_C HBufC8 *EscapeEncodeL(const TDesC8 &, TEscapeMode)
IMPORT_C HBufC16 *EscapeEncodeL(const TDesC16 &, TEscapeMode)
IMPORT_C HBufC8 *EscapeEncodeL(const TDesC8 &, const TDesC8 &)
IMPORT_C HBufC16 *EscapeEncodeL(const TDesC16 &, const TDesC16 &)
IMPORT_C TBoolIsEscapeTriple(const TDesC8 &, TInt &)
IMPORT_C TBoolIsEscapeTriple(const TDesC16 &, TInt &)
IMPORT_C TBoolIsExcludedChar(TChar)
HBufC8 *ReEscapeEncodeL(const TDesC8 &)
IMPORT_C HBufC8 *SpecificEscapeEncodeL(const TDesC8 &, const TDesC8 &)
Private Member Functions
IMPORT_C HBufC8 *DummyForwardingFunctionForCompatibility(const TDesC8 &, const TDesC8 &)
Public Member Enumerations
enumTEscapeMode { EEscapeNormal = 0, EEscapeQuery, EEscapePath, EEscapeAuth, EEscapeUrlEncoded }

Member Functions Documentation

ConvertFromUnicodeToUtf8L(const TDesC &)

IMPORT_C HBufC8 *ConvertFromUnicodeToUtf8L(const TDesC &aData)[static]

Parameters

const TDesC & aData

ConvertToUnicodeFromUtf8L(const TDesC8 &)

IMPORT_C HBufC *ConvertToUnicodeFromUtf8L(const TDesC8 &aData)[static]

Parameters

const TDesC8 & aData

DummyForwardingFunctionForCompatibility(const TDesC8 &, const TDesC8 &)

IMPORT_C HBufC8 *DummyForwardingFunctionForCompatibility(const TDesC8 &aData,
const TDesC8 &aCharsToEscape
)[private, static]

Parameters

const TDesC8 & aData
const TDesC8 & aCharsToEscape

EscapeDecodeL(const TDesC8 &)

IMPORT_C HBufC8 *EscapeDecodeL(const TDesC8 &aData)[static]

Parameters

const TDesC8 & aData

EscapeDecodeL(const TDesC16 &)

IMPORT_C HBufC16 *EscapeDecodeL(const TDesC16 &aData)[static]

Parameters

const TDesC16 & aData

EscapeEncodeL(const TDesC8 &, TEscapeMode)

IMPORT_C HBufC8 *EscapeEncodeL(const TDesC8 &aData,
TEscapeModeaMode
)[static]

Parameters

const TDesC8 & aData
TEscapeMode aMode

EscapeEncodeL(const TDesC16 &, TEscapeMode)

IMPORT_C HBufC16 *EscapeEncodeL(const TDesC16 &aData,
TEscapeModeaMode
)[static]

Parameters

const TDesC16 & aData
TEscapeMode aMode

EscapeEncodeL(const TDesC8 &, const TDesC8 &)

IMPORT_C HBufC8 *EscapeEncodeL(const TDesC8 &aData,
const TDesC8 &aReservedChars
)[static]

Parameters

const TDesC8 & aData
const TDesC8 & aReservedChars

EscapeEncodeL(const TDesC16 &, const TDesC16 &)

IMPORT_C HBufC16 *EscapeEncodeL(const TDesC16 &aData,
const TDesC16 &aReservedChars
)[static]

Parameters

const TDesC16 & aData
const TDesC16 & aReservedChars

IsEscapeTriple(const TDesC8 &, TInt &)

IMPORT_C TBoolIsEscapeTriple(const TDesC8 &aData,
TInt &aHexValue
)[static]

Parameters

const TDesC8 & aData
TInt & aHexValue

IsEscapeTriple(const TDesC16 &, TInt &)

IMPORT_C TBoolIsEscapeTriple(const TDesC16 &aData,
TInt &aHexValue
)[static]

Parameters

const TDesC16 & aData
TInt & aHexValue

IsExcludedChar(TChar)

IMPORT_C TBoolIsExcludedChar(TCharaChar)[static]

Parameters

TChar aChar

ReEscapeEncodeL(const TDesC8 &)

HBufC8 *ReEscapeEncodeL(const TDesC8 &aData)[static]

Parameters

const TDesC8 & aData

SpecificEscapeEncodeL(const TDesC8 &, const TDesC8 &)

IMPORT_C HBufC8 *SpecificEscapeEncodeL(const TDesC8 &aData,
const TDesC8 &aCharsToEscape
)[static]

Parameters

const TDesC8 & aData
const TDesC8 & aCharsToEscape

Member Enumerations Documentation

Enum TEscapeMode

enum TEscapeMode Enum defining escaping modes. Each mode has a different set of reserved characters. These are based on various uri components, as decribed in RFC2396.

Enumerators

EEscapeNormal = 0

Default mode, which has no reserved characters

EEscapeQuery

Mode specifying reserved characters in a uri query - ;/?:&=+$,[]

EEscapePath

Mode specifying reserved characters in a uri path - /;=?[]

EEscapeAuth

Mode specifying reserved characters in a uri authority - /;:@?[]

EEscapeUrlEncoded

Mode specifying reserved characters in a URL ;/?:&=+$[]!\'()~

© Nokia 2010.