就业培训     下载中心     Wiki     联络 登录   注册

---

◆  Shrink()

Optimizes the memory usage. This can only be done if the string previously contained 16- or 32-bit Unicode characters that now have been removed or if the string was longer before.

返回

OK on success. Also returns OK if the string already is in its smallest state.

◆  Append() [1/2]

Concatenates 2 strings, use this operation instead of a = a + b as it is much faster.

返回

OK on success.

◆  Append() [2/2]

Concatenates 2 strings of which the second is represented by len characters at address str in memory.

参数

[in]	str	Character pointer.
[in]	len	Number of characters.

返回

OK on success.

◆  AppendChar()

Appends a character to the current string.

参数

[in]

v

The character that will be added.

返回

OK on success.

◆  FindIndex() [1/2]

Searches for the first occurrence of 'str' within a string.

参数

[in]	str	The search string.
[in]	start	Starting position within the current string to search from. If it is out of bounds the function will return InvalidArrayIndex.

返回

The index at which 'str' has been found or InvalidArrayIndex. @MAXON_ANNOTATION{default=InvalidArrayIndex}

◆  FindLastIndex() [1/2]

Searches for the last occurrence of 'str' within a string.

参数

[in]	str	The search string.
[in]	start	Starting position within the current string to search from (backwards). The character at the given position will not be included in the search. If it is out of bounds the function will return InvalidArrayIndex.

返回

The index at which 'str' has been found or InvalidArrayIndex. @MAXON_ANNOTATION{default=InvalidArrayIndex}

◆  FindIndex() [2/2]

Searches for the first occurrence of character 'ch' within a string.

参数

[in]	ch	The search character.
[in]	start	Starting position within the current string to search from. If it is out of bounds the function will return InvalidArrayIndex.

返回

The index at which 'ch' has been found or InvalidArrayIndex. @MAXON_ANNOTATION{default=InvalidArrayIndex}

◆  FindLastIndex() [2/2]

Searches for the last occurrence of character 'ch' within a string.

参数

[in]	ch	The search character.
[in]	start	Starting position within the current string to search from (backwards). The character at the given position will not be included in the search. If it is out of bounds the function will return InvalidArrayIndex.

返回

The index at which 'ch' has been found or InvalidArrayIndex. @MAXON_ANNOTATION{default=InvalidArrayIndex}

◆  FindUpperIndex()

Uppercase search for the first occurrence of 'str' within a string (which doesn't need to contain uppercase characters).

参数

[in]	str	The search string, must be completely uppercase, otherwise no matches will be found.
[in]	start	Starting position within the current string to search from. If it is out of bounds the function will return InvalidArrayIndex.

返回

The index at which 'str' has been found or InvalidArrayIndex. @MAXON_ANNOTATION{default=InvalidArrayIndex}

◆  FindLastUpperIndex()

Uppercase search for the last occurrence of 'str' within a string (which doesn't need to contain uppercase characters).

参数

[in]	str	The search string, must be completely uppercase, otherwise no matches will be found.
[in]	start	Starting position within the current string to search from (backwards). The character at the given position will not be included in the search. If it is out of bounds the function will return InvalidArrayIndex.

返回

The index at which 'str' has been found or InvalidArrayIndex. @MAXON_ANNOTATION{default=InvalidArrayIndex}

◆  Erase()

Erases a range of characters within a string.

参数

[in]	position	The starting position to delete 'count' characters. If the position is out of bounds an error will be returned.
[in]	count	Number of characters to delete. If you want to delete all characters until the end pass StringEnd(). If the number is larger than what is available an error will be returned.

返回

OK on success.

◆  Insert() [1/2]

Inserts a string at a specific position.

参数

[in]	position	Insert position in the current string. StringEnd() is a valid position. If the position is out of bounds an error is returned.
[in]	str	String to be inserted.
[in]	strStart	Starting position of the string to be inserted. If the position is out of bounds an error is returned.
[in]	strCount	Number of characters to be inserted. If the number of characters is too large an error is returned.

返回

OK on success.

◆  Insert() [2/2]

Inserts a single unicode character at a specific position.

参数

[in]	position	Insert position, needs to be within boundaries.
[in]	ch	Unicode character to insert.

返回

OK on success.

◆  GetPart()

Creates a part of the current string.

参数

[in]	start	Position where the new partial string will start.
[in]	count	Number of characters for the partial string. If it is larger than the number of available characters an empty string will be returned.

返回

The partial string, or empty string if 'start' was out of boundaries. Will be an empty reference if GetPart fails (apply iferr for error handling).

◆  ToUpper()

Returns the uppercase version of a string.

返回

Uppercase version of a string. Will be an empty reference if ToUpper fails (apply iferr for error handling).

◆  ToLower()

Returns the lowercase version of a string.

返回

Lowercase version of a string. Will be an empty reference if ToLower fails (apply iferr for error handling).

◆  ComparePart()

Compares a part of this against 'str' for exact match. Example:

returns COMPARESTRING::EQUAL for matching "bcd"

参数

[in]	str	Comparison object.
[in]	mode	Comparison mode.
[in]	position	Starting position in the current string that 'str' will be compared against. The interval [position..count] will be clipped against valid boundaries.
[in]	count	Number of characters in the current string that 'str' will be compared against. count can be longer than the string length and will be clipped accordingly.

返回

See COMPARERESULT.

◆  Compare()

Compares the object against 'str' for exact match.

参数

[in]	str	Comparison object.
[in]	mode	Comparison mode.

返回

See COMPARERESULT.

◆  IsEqual()

Compare strings for equality.

返回

True if equal.

◆  GetHashCode()

◆  SetChar()

Changes the character at the given position (used internally by CharPtr ).

参数

[in]	pos	Character index. If it is negative the position is relative to end, e.g. -1 indicates the last character. The position must be within boundaries, however only a debug assert will happen otherwise.
[in]	ch	Character value.

@MAXON_ANNOTATION{refclass=false}

◆  GetChar()

Retrieves the character at a given position. If the position is out of bounds 0 will be returned.

参数

[in]

pos

Character position. If it is negative the position is relative to end, e.g. -1 indicates the last character. The position must be within boundaries, however only a debug assert will happen otherwise.

返回

The character.

@MAXON_ANNOTATION{refclass=false}

◆  ToFloat64()

Converts a string to a 64-bit floating point value. This routine does no formula parsing. While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Floating point value of the string.

◆  ToFloat32()

Converts a string to a 32-bit floating point value. This routine does no formula parsing. While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Floating point value of the string.

◆  ToFloat()

Converts a string to a floating point value. This routine does no formula parsing. While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Floating point value of the string.

◆  ToInt64()

Converts a string to a 64 bit integer value. This routine does no formula parsing and does not support any suffixes/prefixes except for 0x (hexadecimal numbers). While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Integer value of the string.

◆  ToInt32()

Converts a string to a 32 bit integer value. This routine does no formula parsing and does not support any suffixes/prefixes except for 0x (hexadecimal numbers). While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Integer value of the string.

◆  ToInt()

Converts a string to an integer value. This routine does no formula parsing and does not support any suffixes/prefixes except for 0x (hexadecimal numbers). While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Integer value of the string.

◆  ToUInt64()

Converts a string to a 64 bit unsigned integer value. This routine does no formula parsing and does not support any suffixes/prefixes except for 0x (hexadecimal numbers). While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Integer value of the string.

◆  ToUInt32()

Converts a string to a 32 bit unsigned integer value. This routine does no formula parsing and does not support any suffixes/prefixes except for 0x (hexadecimal numbers). While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Integer value of the string.

◆  ToUInt()

Converts a string to an unsigned integer value. This routine does no formula parsing and does not support any suffixes/prefixes except for 0x (hexadecimal numbers). While leading whitespaces are allowed by default no trailing characters of any kind are allowed.

参数

[in]

flags

Optional flags for the conversion.

返回

Integer value of the string.

◆  FloatToString() [1/2]

Converts a floating point value into formatted text.

参数

[in]	value	Floating point value to convert into text.
[in]	charsBeforeComma	Characters before the decimal point. If STRING_DYNAMIC_DIGITS is passed or 'charsBeforeComma' is too low to represent 'value' it is automatically increased/adjusted. If 'charsBeforeComma' is positive and exponent is false fill characters will be added to the beginning. If STRING_MAXIMUM_PRECISION is passed, then the result will be an exact representation of the value (possibly using exponential notation).
[in]	digitsAfterComma	Digits after the decimal point. If a negative number is passed the number of digits is automatically chosen and up to (-digitsAfterComma).
[in]	exponent	Force exponential-style output (e.g. 1.0e+10).
[in]	fillChar	Fill character for digits before the decimal point. E.g. if you specify 4 for charsBeforeComma, '*' for fillChar and your value is 1.5 you'll get ***1.5 as a result. This value has no impact if exponent is true.

返回

String object with the decimal text of the value.

◆  FloatToString() [2/2]

Converts a floating point value into formatted text.

参数

[in]	value	Floating point value to convert into text.
[in]	charsBeforeComma	Characters before the decimal point. If STRING_DYNAMIC_DIGITS is passed or 'charsBeforeComma' is too low to represent 'value' it is automatically increased/adjusted. If 'charsBeforeComma' is positive and exponent is false fill characters will be added to the beginning. If STRING_MAXIMUM_PRECISION is passed, then the result will be an exact representation of the value (possibly using exponential notation).
[in]	digitsAfterComma	Digits after the decimal point. If a negative number is passed the number of digits is automatically chosen and up to (-digitsAfterComma).
[in]	exponent	Force exponential-style output (e.g. 1.0e+10).
[in]	fillChar	Fill character for digits before the decimal point. E.g. if you specify 4 for charsBeforeComma, '*' for fillChar and your value is 1.5 you'll get ***1.5 as a result. This value has no impact if exponent is true.

返回

String object with the decimal text of the value.

◆  AppendInt() [1/2]

Appends a number to the current string.

参数

[in]

v

The number that will be added.

返回

The current string. Will be an empty reference if AppendInt fails (apply iferr for error handling). @MAXON_ANNOTATION{returnsThis,noResult}

◆  AppendUInt() [1/2]

Appends a number to the current string.

参数

[in]

v

The number that will be added.

返回

The current string. Will be an empty reference if AppendUInt fails (apply iferr for error handling). @MAXON_ANNOTATION{returnsThis,noResult}

◆  AppendInt() [2/2]

Appends a number to the current string.

参数

[in]

v

The number that will be added.

返回

The current string. Will be an empty reference if AppendInt fails (apply iferr for error handling). @MAXON_ANNOTATION{returnsThis,noResult}

◆  AppendUInt() [2/2]

Appends a number to the current string.

参数

[in]

v

The number that will be added.

返回

The current string. Will be an empty reference if AppendUInt fails (apply iferr for error handling). @MAXON_ANNOTATION{returnsThis,noResult}

◆  IntToString() [1/2]

Formats a Int32 value as decimal text.

参数

[in]

v

Int32 value.

返回

String object with the decimal text of the value. Will be an empty reference on failure (apply iferr for error handling).

◆  UIntToString() [1/2]

Formats a UInt32 value as decimal text.

参数

[in]

v

UInt32 value.

返回

String object with the decimal text of the value. Will be an empty reference on failure (apply iferr for error handling).

◆  IntToString() [2/2]

Formats a Int64 value as decimal text.

参数

[in]

v

Int64 value.

返回

String object with the decimal text of the value. Will be an empty reference on failure (apply iferr for error handling).

◆  UIntToString() [2/2]

Formats a UInt64 value as decimal text.

参数

[in]

v

Int64 value.

返回

String object with the decimal text of the value. Will be an empty reference on failure (apply iferr for error handling).

◆  MemorySizeToString()

Formats a Int64 value as a memory information.

参数

[in]	v	The size of bytes that should be formated as memory text.
[in]	mebibytes	defines if a value of 1343443 is either output as "1.28 MiB" (mebibytes) or "1.34 MB" (megabytes).

返回

String object for the given mem value.

◆  HexToString() [1/2]

Formats a Int32 value as hexadecimal text.

参数

[in]	v	Int32 value.
[in]	prefix0x	Start the string with 0x as prefix.

返回

String object with the hexadecimal text of the value.

◆  HexToString() [2/2]

Formats a Int64 value as hexadecimal text.

参数

[in]	v	Int64 value.
[in]	prefix0x	Start the string with 0x as prefix.

返回

String object with the hexadecimal text of the value.

◆  PointerToString()

Formats a pointer as hexadecimal text. The pointer starts with 0x prefix.

参数

[in]

v

Pointer to convert.

返回

String object with the hexadecimal text of the value.

◆  GetUtf32()

Copies the string as UTF-32 encoded characters into the passed array. The array will be resized and contain the non \0 - terminated data.

参数

[out]

stringData

The array to receive the data.

返回

OK on success.

◆  TrimLeft()

Removes all characters with value <= 0x20 (e.g. space, tab, line feed) at the beginning of the string.

返回

OK on success.

◆  TrimRight()

Removes all characters with value <= 0x20 (e.g. space, tab, line feed) at the end of the string.

返回

OK on success.

◆  Split()

Splits the string into parts separated by the split symbol (e.g. a comma).

参数

[in]	splitSymbol	String containing the split symbol.
[in]	trim	If true each separated part will be trimmed (see Trim).
[out]	parts	Array to be filled with the separated strings.

返回

OK on success.

◆  Replace() [1/3]

Replaces all occurrences of the character 'find' in the current string with the given character 'replace'.

参数

[in]	find	Search character. Each occurrence will be replaced with 'replace'.
[in]	replace	Replacement of 'find'.

返回

Number of replaced characters.

◆  Replace() [2/3]

Replaces all occurrences of string 'find' in the current string with the given string 'replace'.

参数

[in]	find	Search string. Each occurrence will be replaced with 'replace'.
[in]	replace	Replacement of 'find'. Can be an empty string, in which case all 'find' strings will be removed.

返回

Number of replaced strings.

◆  Replace() [3/3]

Replaces all occurrences of the character 'find' in the current string with the given string 'replace'.

参数

[in]	find	Search character. Each occurrence will be replaced with 'replace'.
[in]	replace	Replacement of 'find'. Can be an empty string, in which case all 'find' characters will be removed.

返回

Number of replaced strings.

◆  Find() [1/2]

Searches for the first occurrence of 'str' within a string.

参数

[in]	str	The search string.
[out]	pos	Pointer to be filled with the position where 'str' was found. This parameter can be a nullptr. In case no occurence was found *pos is initialized with InvalidArrayIndex.
[in]	start	Starting position within the current string to search from. If it is out of bounds the function will return false.

返回

True if 'str' has been found, in that case *pos contains the position where the first occurance was found.

◆  FindLast() [1/2]

Searches for the last occurrence of 'str' within a string.

参数

[in]	str	The search string.
[out]	pos	Pointer to be filled with the position where 'str' was found. This parameter can be a nullptr. In case no occurence was found *pos is initialized with InvalidArrayIndex.
[in]	start	Starting position within the current string to search from (backwards). The character at the given position will not be included in the search. If it is out of bounds the function will return false.

返回

True if 'str' has been found, in that case *pos contains the position where the last occurance was found.

◆  Find() [2/2]

Searches for the first occurrence of character 'ch' within a string.

参数

[in]	ch	The search character.
[out]	pos	Pointer to be filled with the position where 'ch' was found. This parameter can be a nullptr. In case no occurence was found *pos is initialized with InvalidArrayIndex.
[in]	start	Starting position within the current string to search from. If it is out of bounds the function will return false.

返回

True if 'ch' has been found, in that case *pos contains the position where the first occurance was found.

◆  FindLast() [2/2]

Searches for the last occurrence of character 'ch' within a string.

参数

[in]	ch	The search character.
[out]	pos	Pointer to be filled with the position where 'ch' was found. This parameter can be a nullptr. In case no occurence was found *pos is initialized with InvalidArrayIndex.
[in]	start	Starting position within the current string to search from (backwards). The character at the given position will not be included in the search. If it is out of bounds the function will return false.

返回

True if 'ch' has been found, in that case *pos contains the position where the last occurance was found.

◆  FindUpper()

Uppercase search for the first occurrence of 'str' within a string (which doesn't need to contain uppercase characters).

参数

[in]	str	The search string, must be completely uppercase, otherwise no matches will be found.
[out]	pos	Pointer to be filled with the position where 'ch' was found. This parameter can be a nullptr. In case no occurence was found *pos is initialized with InvalidArrayIndex.
[in]	start	Starting position within the current string to search from. If it is out of bounds the function will return false.

返回

True if 'str' has been found, in that case *pos contains the position where the first occurance was found.

◆  FindLastUpper()

Uppercase search for the last occurrence of 'str' within a string (which doesn't need to contain uppercase characters).

参数

[in]	str	The search string, must be completely uppercase, otherwise no matches will be found.
[out]	pos	Pointer to be filled with the position where 'ch' was found. This parameter can be a nullptr. In case no occurence was found *pos is initialized with InvalidArrayIndex.
[in]	start	Starting position within the current string to search from (backwards). The character at the given position will not be included in the search. If it is out of bounds the function will return false.

返回

True if 'str' has been found, in that case *pos contains the position where the last occurance was found.

◆  GetLeftPart()

Returns the string part left of the given position. The character at position will not be included.

参数

[in]

start

Partitioning position.

返回

The partial string, or empty string if 'start' was out of boundaries. Will be an empty reference on failure (apply iferr for error handling).

◆  GetRightPart()

Returns the string part right of the given position. The character at position will be included.

参数

[in]

start

Partitioning position.

返回

The partial string, or empty string if 'start' was out of boundaries. Will be an empty reference on failure (apply iferr for error handling).

◆  StartsWith() [1/2]

Checks if the string starts with a certain character.

参数

[in]

ch

The character to be checked.

返回

True if the string starts with the given character.

◆  StartsWith() [2/2]

Checks if the current string starts with a given string.

参数

[in]

str

The string part.

返回

True if the string starts with the string 'str'.

◆  EndsWith() [1/2]

Checks if the string ends with a certain character.

参数

[in]

ch

The character to be checked.

返回

True if the string end with the given character.

◆  EndsWith() [2/2]

Checks if the current string end with a given string.

参数

[in]

str

The string part.

返回

True if the string ends with the string 'str'.

◆  Trim()

Removes all characters with value <= 0x20 (e.g. space, tab, line feed) at the beginning and the end of the string.

返回

OK on success.

• maxon
• StringTemplate