lstl::CStringListBase< _tStringType > Class Template Reference

An array of strings with some useful additions.. More...

#include <LSTLStringListBase.h>

Inheritance diagram for lstl::CStringListBase< _tStringType >:

List of all members.

Public Member Functions
LSBOOL LSE_CALL	MakeFromUtf8 (const char *_pcText, LSUINT32 _ui32Len, LSBOOL _bKeepNewLines=false)
_tStringType LSE_CALL	ToString (LSBOOL _bAddNewLines)
template<typename _tCharType >
LSBOOL LSE_CALL	MakeByTokenizing (const _tCharType *_ptString, LSUINT32 _ui32Length, _tCharType _tTokenizer)

---

Detailed Description

template<typename _tStringType>
class lstl::CStringListBase< _tStringType >

An array of strings with some useful additions..

Class CStringListBase Description: An array of strings with some useful additions..

---

Member Function Documentation

template<typename _tStringType >

template<typename _tCharType >

LSBOOL LSE_CALL lstl::CStringListBase< _tStringType >::MakeByTokenizing	(	const _tCharType *	_ptString,
		LSUINT32	_ui32Length,
		_tCharType	_tTokenizer
	)		[inline]

Creates a string array by tokenizing the given character array. If the tokenizer appears twice in a row within the input string, an empty string entry is added to the string array.

Parameters:

_ptString	Pointer to an array of characters to be tokenized. The array is not considered to be in any specific UTF format, and the string is tokenized on a per-character basis.
_ui32Length	Length, in characters, of the array to which _ptString points.
_tTokenizer	Character by which to tokenize the string.

Returns:

Returns true if the string was successfully tokenized.

template<typename _tStringType >

LSBOOL LSE_CALL lstl::CStringListBase< _tStringType >::MakeFromUtf8	(	const char *	_pcText,
		LSUINT32	_ui32Len,
		LSBOOL	_bKeepNewLines = false
	)		[inline]

Create a string list in which each line of the given text is a new string in the array. New-line characters may optionally be discarded.
is considered the only new-line character, however is stripped as well if stripping is requested.

Parameters:

_pcText	The text to be converted to a multi-string list.
_ui32Len	Length of the input string to which _pcText points.
_bKeepNewLines	If true, new-line characters and are kept.

Returns:

Returns true if there was enough memory to perform the full conversion.

template<typename _tStringType >

_tStringType LSE_CALL lstl::CStringListBase< _tStringType >::ToString

(

LSBOOL

_bAddNewLines

)

[inline]

Create a single string from this array of strings. The final string is the result of appending all of the strings in this list to each other. New-line characters may optionally be added between strings. New-line characters consist of
here.

Parameters:

_bAddNewLines

If true, the new-line combo is inserted between strings when creating the final string.

Returns:

Returns the new string, which represents the result of appending each string in this list one after another.

---

The documentation for this class was generated from the following file:

• F:/My Projects/LSEngine/Modules/LSTL/Src/String/LSTLStringListBase.h