#include <inetprottextutils.h>
| class InetProtTextUtils |
| Public Member Enumerations | |
|---|---|
| enum | TRemoveMode { ERemoveLeft, ERemoveRight, ERemoveBoth } |
Comments :
enum TRemoveMode Enum defining whitespace removal modes.
| Enumerator | Value | Description |
|---|---|---|
| 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. |
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 | |
|---|---|
| aData | The descriptor buffer to be parsed. |
| aHex | An output argument set to the numeric value of the parsed hex number. |
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 | |
|---|---|
| aData | The descriptor buffer to be parsed. |
| aHex | An output argument set to the numeric value of the parsed hex number. |
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 | |
|---|---|
| aData | A descriptor pointer with the data. |
| aInt | An output argument in which the numeric value of the data is placed. |
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 | |
|---|---|
| aData | A descriptor pointer with the data. |
| aInt | An output argument in which the numeric value of the data is placed. |
Converts an integer to its hex representation.
| Parameters | |
|---|---|
| aHex | The integer value to convert. |
| aBuffer | An output argument that is set to the buffer containing the hex representation of aValue. |
| Panic Codes | |
|---|---|
| EInvariantFalse | The integer value was too big. |
Converts an integer to its hex representation.
| Parameters | |
|---|---|
| aHex | The integer value to convert. |
| aBuffer | An output argument that is set to the buffer containing the hex representation of aValue. |
| Panic Codes | |
|---|---|
| EInvariantFalse | The integer value was too big. |
Converts an integer value into its decimal character representation.
| Parameters | |
|---|---|
| aInt | An integer value. |
| aBuffer | An output argument of a pointer to a data buffer that will contain the character representation of the integer value. |
| IMPORT_C TInt | ExtractIntegerValueL | ( | TPtrC8 & | aBuffer, |
| TInt & | aIntVal, | |||
| TBool | aAllowNonWsTerminator | |||
| ) | [static] | |||
Extract an integer value from the head of the supplied buffer.
| Parameters | |
|---|---|
| aBuffer | The buffer containing the integer value. |
| aIntVal | An output argument in which extracted integer value is placed. |
| aAllowNonWsTerminator | If set to true whitespace is considered as the terminator, if set to false a non-decimal charecter is considered as terminator. |
| Leave Codes | |
|---|---|
| KUriUtilsErrMalformedInteger | if the value in aBuffer is not an integer (ie, contains non-decimal characters, or is too big to fit in a TInt) |
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 | |
|---|---|
| aBuffer | The buffer containing the token-list. |
| aToken | An output argument containing the extracted token. |
| aSeparator | The separator character. |
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 | |
|---|---|
| aBuffer | The buffer containing the token-list. |
| aToken | An output argument containing the extracted token. |
| aSeparator | The separator character. |
| 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 | |
|---|---|
| aBuffer | The buffer containing the token-list. |
| aToken | An output argument containing the extracted token. |
| aSeparators | The list of separator characters. |
| 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 | |
|---|---|
| aBuffer | The buffer containing the token-list. |
| aToken | An output argument containing the extracted token. |
| aSeparators | The list of separator characters. |
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 | |
|---|---|
| aBuffer | The buffer containing the quoted. |
| aQuotedString | An output argument containing the extracted string. |
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 | |
|---|---|
| aBuffer | The buffer containing the quoted. |
| aQuotedString | An output argument containing the extracted string. |
| 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 | |
|---|---|
| aData | A descriptor pointer with the data. |
| aMode | The specified removal mode. |
| 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 | |
|---|---|
| aData | A descriptor pointer with the data. |
| aMode | The specified removal mode. |