Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » Str |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| <Str> | Str | This is the <Str> object constructor. |
| int32 | Append | Appends the <Str> object with the value of another string. |
| int32 | AppendChar | Appends a char onto the <Str> object. |
| int32 | CountOfChar | Returns the number of occurrences in the <Str> object of the specified char. |
| int64 | Find | Finds the first occurrence of a particular string inside a string. |
| uint64 | FindFirst | Finds the first occurrence of the specified character sequence. |
| uint64 | FindLast | Finds the last occurrence of the specified character sequence. |
| string | FormatParagraph | Formats a string to fit inside the specified column width. |
| int32 | GetCount | Returns the length of the <Str> object. |
| int32 | GetUint8Array | Populates a <Uint8Array> with the values of the individual chars in the <Str>. |
| <Uint8ArrayView> | GetView | Returns a pointer to a <Uint8ArrayView> object with iterators to the beginning and end of the <Str> object. This object is allocated with new so you must declare with auto. For example: auto Uint8ArrayView view = my_str.GetView(); |
| int32 | In | Returns true if the specified sub-string is present in a string. |
| int32 | IsAllSpaces | Returns true if the string only contains spaces. |
| int32 | IsBlank | Returns true if the <Str> object is blank. This means it must not include any terminating sequence such as \0. |
| int32 | IsEmptySpace | Returns true if the string only contains spaces. |
| int32 | IsFloatLiteral | Returns true if the <Str> object represents a single or double-precision floating-point literal. |
| int32 | IsIntLiteral | Returns true if the <Str> object represents an <int32> or <uint32> literal. |
| static int32 | IsLower | Returns true if the specified char is lowercase. |
| static int32 | IsUpper | Returns true if the specified char is uppercase. |
| string | Left | Trims the string from its start to the specified number of characters left of the start. |
| int32 | Length | Returns the length of the string in characters. |
| int32 | MakeLowercase | Converts all the characters in the specified <Str> object to lower case. |
| string | PrintFloat64 | Prints a <float64>. |
| string | Replace | Replaces one sequence of characters with another sequence of characters. |
| int32 | ReplaceChars | Replaces a set of chars in the <Str> object with the specified character. Internally, this uses std::find_first_of. |
| string | ReplaceWords | Replaces the source string with the destination string. |
| int64 | ReverseFind | Finds the first occurrence of a particular string inside a string, but starts the search at the end of the string instead of at the beginning. |
| string | Right | Trims the string to include everything to the right of the specified start position. |
| int32 | SetLength | Sets the length of the underlying array of characters. |
| string | Substring | Returns a string containing a section of the <Str>. |
| float64 | ToFloat32 | Converts a string to a <float32> value. |
| float64 | ToFloat64 | Converts a string to a <float64> value. |
| int32 | ToInt32 | Converts a string to an <int32> value. |
| static int32 | ToLower | Returns the ASCII character representing the lowercase version of an uppercase character from the English alphabet. |
| static int32 | ToUpper | Returns the ASCII character representing the uppercase version of a lowercase character from the English alphabet. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| int32 | Count | Gets or sets the length of the <Str>. |
| int32[] | Objects[ index ] | Sets the value of an element in the array at the specified index, or returns the value of the element at the specified index. Accessor syntax is myStr.Objects[n]. |
| string | Value | Returns a string that contains the value of the <Str> object. |