Symbian^3 Application Developer Library >

InetProtTextUtils Class Reference

class InetProtTextUtils

Comments :

Public Member Functions
IMPORT_C TInt ConvertDescriptorToHex (const TDesC8 &, TInt &)
IMPORT_C TInt ConvertDescriptorToHex (const TDesC16 &, TInt &)
IMPORT_C TInt ConvertDescriptorToInt (const TDesC8 &, TInt &)
IMPORT_C TInt ConvertDescriptorToInt (const TDesC16 &, TInt &)
IMPORT_C void ConvertHexToDescriptorL ( TInt , HBufC8 *&)
IMPORT_C void ConvertHexToDescriptorL ( TInt , HBufC16 *&)
IMPORT_C void ConvertIntToDescriptorL ( TInt , HBufC8 *&)
IMPORT_C void ConvertIntToDescriptorL ( TInt , HBufC16 *&)
IMPORT_C TInt ExtractIntegerValueL ( TPtrC8 &, TInt &, TBool )
IMPORT_C TInt ExtractNextTokenFromList ( TPtrC8 &, TPtrC8 &, TChar )
IMPORT_C TInt ExtractNextTokenFromList ( TPtrC16 &, TPtrC16 &, TChar )
IMPORT_C TInt ExtractNextTokenFromList ( TPtrC8 &, TPtrC8 &, const TDesC8 &)
IMPORT_C TInt ExtractNextTokenFromList ( TPtrC16 &, TPtrC16 &, const TDesC16 &)
IMPORT_C TInt ExtractQuotedStringL ( TPtrC8 &, TPtrC8 &)
IMPORT_C TInt ExtractQuotedStringL ( TPtrC16 &, TPtrC16 &)
IMPORT_C TInt RemoveWhiteSpace ( TPtrC8 &, TRemoveMode )
IMPORT_C TInt RemoveWhiteSpace ( TPtrC16 &, TRemoveMode )
Public Member Enumerations
enum TRemoveMode { ERemoveLeft  = 0, ERemoveRight , ERemoveBoth }

Member Functions Documentation

ConvertDescriptorToHex(const TDesC8 &, TInt &)

IMPORT_C TInt ConvertDescriptorToHex ( const TDesC8 & aData,
TInt & aHex
) [static]

Descriptor to hex convertor. Searches the descriptor buffer for a hex number representation at the start of the buffer. The hex number is deemed to have ended when the first non-hex character is found. The numeric value of the hex number is returned along with the number characters consumed in obtaining the number. The amount of leading whitespace is included in the number of characters consumed.

Parameters

const TDesC8 & aData The descriptor buffer to be parsed.
TInt & aHex An output argument set to the numeric value of the parsed hex number.

ConvertDescriptorToHex(const TDesC16 &, TInt &)

IMPORT_C TInt ConvertDescriptorToHex ( const TDesC16 & aData,
TInt & aHex
) [static]

Descriptor to hex convertor. Searches the descriptor buffer for a hex number representation at the start of the buffer. The hex number is deemed to have ended when the first non-hex character is found. The numeric value of the hex number is returned along with the number characters consumed in obtaining the number. The amount of leading whitespace is included in the number of characters consumed.

Parameters

const TDesC16 & aData The descriptor buffer to be parsed.
TInt & aHex An output argument set to the numeric value of the parsed hex number.

ConvertDescriptorToInt(const TDesC8 &, TInt &)

IMPORT_C TInt ConvertDescriptorToInt ( const TDesC8 & aData,
TInt & aInt
) [static]

Converts the character representation of an integer into its numeric value. Preceeding whitespace is ignored and the integer is delimited by either the end of the data, whitespace or any other character other than 0 to 9.

Parameters

const TDesC8 & aData A descriptor pointer with the data.
TInt & aInt An output argument in which the numeric value of the data is placed.

ConvertDescriptorToInt(const TDesC16 &, TInt &)

IMPORT_C TInt ConvertDescriptorToInt ( const TDesC16 & aData,
TInt & aInt
) [static]

Converts the character representation of an integer into its numeric value. Preceeding whitespace is ignored and the integer is delimited by either the end of the data, whitespace or any other character other than 0 to 9.

Parameters

const TDesC16 & aData A descriptor pointer with the data.
TInt & aInt An output argument in which the numeric value of the data is placed.

ConvertHexToDescriptorL(TInt, HBufC8 *&)

IMPORT_C void ConvertHexToDescriptorL ( TInt aHex,
HBufC8 *& aBuffer
) [static]

Converts an integer to its hex representation.

panic
EInvariantFalse The integer value was too big.

Parameters

TInt aHex The integer value to convert.
HBufC8 *& aBuffer An output argument that is set to the buffer containing the hex representation of aValue.

ConvertHexToDescriptorL(TInt, HBufC16 *&)

IMPORT_C void ConvertHexToDescriptorL ( TInt aHex,
HBufC16 *& aBuffer
) [static]

Converts an integer to its hex representation.

panic
EInvariantFalse The integer value was too big.

Parameters

TInt aHex The integer value to convert.
HBufC16 *& aBuffer An output argument that is set to the buffer containing the hex representation of aValue.

ConvertIntToDescriptorL(TInt, HBufC8 *&)

IMPORT_C void ConvertIntToDescriptorL ( TInt aInt,
HBufC8 *& aBuffer
) [static]

Converts an integer value into its decimal character representation.

Parameters

TInt aInt An integer value.
HBufC8 *& aBuffer An output argument of a pointer to a data buffer that will contain the character representation of the integer value.

ConvertIntToDescriptorL(TInt, HBufC16 *&)

IMPORT_C void ConvertIntToDescriptorL ( TInt aInt,
HBufC16 *& aBuffer
) [static]

Converts an integer value into its decimal character representation.

Parameters

TInt aInt An integer value.
HBufC16 *& aBuffer An output argument of a pointer to a data buffer that will contain the character representation of the integer value.

ExtractIntegerValueL(TPtrC8 &, TInt &, TBool)

IMPORT_C TInt ExtractIntegerValueL ( TPtrC8 & aBuffer,
TInt & aIntVal,
TBool aAllowNonWsTerminator
) [static]

Extract an integer value from the head of the supplied buffer.

leave
KUriUtilsErrMalformedInteger if the value in aBuffer is not an integer (ie, contains non-decimal characters, or is too big to fit in a TInt)

Parameters

TPtrC8 & aBuffer The buffer containing the integer value.
TInt & aIntVal An output argument in which extracted integer value is placed.
TBool aAllowNonWsTerminator If set to true whitespace is considered as the terminator, if set to false a non-decimal charecter is considered as terminator.

ExtractNextTokenFromList(TPtrC8 &, TPtrC8 &, TChar)

IMPORT_C TInt ExtractNextTokenFromList ( TPtrC8 & aBuffer,
TPtrC8 & aToken,
TChar aSeparator
) [static]

Extract a token from the head of the supplied buffer, which is assumed to be a token-list. The tokens are separated by the specified character. Any white space surrounding the token is stripped out. The number of characters consumed from the buffer are returned. The buffer is updated to not include the extracted token including the separator.

Parameters

TPtrC8 & aBuffer The buffer containing the token-list.
TPtrC8 & aToken An output argument containing the extracted token.
TChar aSeparator The separator character.

ExtractNextTokenFromList(TPtrC16 &, TPtrC16 &, TChar)

IMPORT_C TInt ExtractNextTokenFromList ( TPtrC16 & aBuffer,
TPtrC16 & aToken,
TChar aSeparator
) [static]

Extract a token from the head of the supplied buffer, which is assumed to be a token-list. The tokens are separated by the specified character. Any white space surrounding the token is stripped out. The number of characters consumed from the buffer are returned. The buffer is updated to not include the extracted token including the separator.

Parameters

TPtrC16 & aBuffer The buffer containing the token-list.
TPtrC16 & aToken An output argument containing the extracted token.
TChar aSeparator The separator character.

ExtractNextTokenFromList(TPtrC8 &, TPtrC8 &, const TDesC8 &)

IMPORT_C TInt ExtractNextTokenFromList ( TPtrC8 & aBuffer,
TPtrC8 & aToken,
const TDesC8 & aSeparators
) [static]

Extract a token from the head of the supplied buffer, which is assumed to be a token-list. The tokens are separated by one of the specified characters. Any white space surrounding the token is stripped out. The number of characters consumed from the buffer are returned. The buffer is updated to not include the extracted token including the separator.

Parameters

TPtrC8 & aBuffer The buffer containing the token-list.
TPtrC8 & aToken An output argument containing the extracted token.
const TDesC8 & aSeparators The list of separator characters.

ExtractNextTokenFromList(TPtrC16 &, TPtrC16 &, const TDesC16 &)

IMPORT_C TInt ExtractNextTokenFromList ( TPtrC16 & aBuffer,
TPtrC16 & aToken,
const TDesC16 & aSeparators
) [static]

Extract a token from the head of the supplied buffer, which is assumed to be a token-list. The tokens are separated by one of the specified characters. Any white space surrounding the token is stripped out. The number of characters consumed from the buffer are returned. The buffer is updated to not include the extracted token including the separator.

Parameters

TPtrC16 & aBuffer The buffer containing the token-list.
TPtrC16 & aToken An output argument containing the extracted token.
const TDesC16 & aSeparators The list of separator characters.

ExtractQuotedStringL(TPtrC8 &, TPtrC8 &)

IMPORT_C TInt ExtractQuotedStringL ( TPtrC8 & aBuffer,
TPtrC8 & aQuotedString
) [static]

Extract a quoted string value from the head of the supplied buffer. Anything outside the quotes is discarded and the quotes themselves are not included in the returned string.

Parameters

TPtrC8 & aBuffer The buffer containing the quoted.
TPtrC8 & aQuotedString An output argument containing the extracted string.

ExtractQuotedStringL(TPtrC16 &, TPtrC16 &)

IMPORT_C TInt ExtractQuotedStringL ( TPtrC16 & aBuffer,
TPtrC16 & aQuotedString
) [static]

Extract a quoted string value from the head of the supplied buffer. Anything outside the quotes is discarded and the quotes themselves are not included in the returned string.

Parameters

TPtrC16 & aBuffer The buffer containing the quoted.
TPtrC16 & aQuotedString An output argument containing the extracted string.

RemoveWhiteSpace(TPtrC8 &, TRemoveMode)

IMPORT_C TInt RemoveWhiteSpace ( TPtrC8 & aData,
TRemoveMode aMode
) [static]

Removes any contiguous whitespace at the extremes of the data, as specified by aMode. Whitespace is defined by the functions TChar::IsSpace() - white space includes spaces, tabs, and separators (e.g. new line).

Parameters

TPtrC8 & aData A descriptor pointer with the data.
TRemoveMode aMode The specified removal mode.

RemoveWhiteSpace(TPtrC16 &, TRemoveMode)

IMPORT_C TInt RemoveWhiteSpace ( TPtrC16 & aData,
TRemoveMode aMode
) [static]

Removes any contiguous whitespace at the extremes of the data, as specified by aMode. Whitespace is defined by the functions TChar::IsSpace() - white space includes spaces, tabs, and separators (e.g. new line).

Parameters

TPtrC16 & aData A descriptor pointer with the data.
TRemoveMode aMode The specified removal mode.

Member Enumerations Documentation

Enum TRemoveMode

enum TRemoveMode Enum defining whitespace removal modes.

Enumerators

ERemoveLeft = 0

Specifies removal any contiguous whitespace characters at the beginning of some data.

ERemoveRight

Specifies removal any contiguous whitespace characters at the end of some data.

ERemoveBoth

Specifies removal any contiguous whitespace characters at the beginning and end of some data.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.