String Structure
This element is not available using the selected API.
The other API languages all have more natural built-in string types so this type is only available in the C++ API.
String Structure
Represents a Carmenta Engine string.
Namespace: Carmenta::Engine
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp64.dll
Library: CECore.Cpp64.lib
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp64.dll
Library: CECore.Cpp64.lib
Thread safety: Members defined in this class are thread-safe.
Syntax
class StringRemarks
A UTF-8 encoded string. Carmenta Engine holds strings internally in the UTF-8 encoding but this class provides methods that convert to and from other encodings.
Note
Platforms
Windows, Linux, Android
String Members
The String type has the following members.
Constructors
| Name | Description |
|---|---|
| String | Initializes a new instance of the String class. |
Properties
| Name | Description |
|---|---|
| length | Gets the number of characters in the string if converted to the encoding of the current code page. |
| wlength | Gets the number of characters in string if converted to the wide character encoding of the platform. |
Methods
| Name | Description |
|---|---|
| c_str | Converts a String into the current code page. |
| c_wstr | Converts a String into the wide character representation of the platform. |
 fromUtf8 | Creates a new String instance from a copy of the supplied UTF-8 encoded string. |
| operator!= | Determines whether the specified String is differs from the current String. |
| operator< | Checks if the current String is less than the specified String. |
| operator= | Assignment operator. |
| operator== | Determines whether the specified String is equal to the current String. |
| swap | Swaps the internal representation with the specified String. |
| toUtf8 | Returns the contents of this String instance as an UTF-8 encoded string. |