StringOperations Namespace Reference

Provides string manipulation functions. More...

Functions
void	EscapeXML (eC_String &rkText)
void	ReplaceAll (eC_String &rkText, const eC_String &rkSearchText, const eC_String &rkReplacement)
void	ReplaceCharacters (eC_String &rkText, eC_UInt uiPos, eC_UInt uiLen, const eC_String &rkReplacement)
StringList	TokenizeString (const eC_String &ckString, const eC_Char ccSeparator)
void	UnescapeXML (eC_String &rkText)

Detailed Description

Provides string manipulation functions.

Function Documentation

EscapeXML()

void StringOperations::EscapeXML

(

eC_String &

rkText

)

Replaces all occurrences of special characters by the according XML predefined entities:

• & becomes &  

• < becomes &lt;   

• > becomes >   

• ' becomes ' 

• " becomes " 

  Parameters

  [in,out]

  rkText

  The string to be modified.

ReplaceAll()

void StringOperations::ReplaceAll	(	eC_String &	rkText,
		const eC_String &	rkSearchText,
		const eC_String &	rkReplacement
	)

Replaces all occurrences of a given substring by another string.

Example:

eC_String text("abc abc abc");
ReplaceAll(text, "ab", "D");
// text now contains "Dc Dc Dc"

Parameters

[in,out]	rkText	The string to be modified.
[in]	rkSearchText	The string of which all occurrences ought to be replaced.
[in]	rkReplacement	The string with which the search text is replaced.

ReplaceCharacters()

void StringOperations::ReplaceCharacters	(	eC_String &	rkText,
		eC_UInt	uiPos,
		eC_UInt	uiLen,
		const eC_String &	rkReplacement
	)

Replaces one or more characters in a string.

Example:

eC_String text("123456");
ReplaceCharacters(text, 3, 2, "9");
// text now contains "12956"

Parameters

[in,out]	rkText	The string to be modified.
[in]	uiPos	Start position at which characters are replaced.
[in]	uiLen	Number of characters to be replaced.
[in]	rkReplacement	Text to replace the characters with.

TokenizeString()

StringList StringOperations::TokenizeString	(	const eC_String &	ckString,
		const eC_Char	ccSeparator
	)

Splits a string up into a list of substrings. The given separator character specifies where to split up the original string.

Parameters

ckString	Original string which shall be split up into substrings
ccSeparator	Special character which separates the individual substrings within the original string

Returns

List of substrings (they will not include any separators)

UnescapeXML()

void StringOperations::UnescapeXML

(

eC_String &

rkText

)

Replaces all occurrences of XML predefined entities by the according characters:

• &  becomes & 

• &lt;   becomes < 

• >   becomes > 

• ' becomes ' 

• " becomes " 

  Parameters

  [in,out]

  rkText

  The string to be modified.