System::String Class Reference

String class used across the library. Is a substitute for C# System.String when translating code. For optimization reasons, isn't considered an Object subclass. This type should be allocated on stack and passed to functions by value or by reference. Never use System::SmartPtr class to manage objects of this type. More...

#include <string.h>

Public Types
using	reverse_iterator = std::reverse_iterator< const char16_t * >
	Reverse iterator type. More...

Public Member Functions
	String ()
	Default constructor. Creates string object which is considered null. More...
template<typename T >
	String (T &value, typename std::enable_if< IsStringLiteral< T, char16_t >::value >::type *=nullptr)
	Constructs string based on string literal. Considers literal a null-terminated string, calculates target string length based on literal size. More...
template<typename T >
	String (const T &value, typename std::enable_if< IsStringPointer< T, char16_t >::value >::type *=nullptr)
	Constructs string based on character string pointer. Treats pointed string as null-terminated, calculates target string length based on null character. More...
template<typename T >
	String (T &value, typename std::enable_if< IsStringLiteral< T, char >::value >::type *=nullptr)
	Constructs string based on string literal. Considers literal a null-terminated string in UTF8, calculates target string length based on literal size. More...
template<typename T >
	String (const T &value, typename std::enable_if< IsStringPointer< T, char >::value >::type *=nullptr)
	Constructs string based on character string pointer. Treats pointed string as null-terminated in UTF8, calculates target string length based on null character. More...
	String (const char16_t *str, int length)
	Constructs string from character string pointer and explicit length. More...
	String (const char *str, int length)
	Constructs string from character string pointer and explicit length. More...
	String (const char16_t *str, int start, int length)
	Constructs string from character string pointer from starting position using length. More...
	String (const char16_t ch, int count)
	Fill constructor. More...
template<typename T >
	String (const T &value, typename std::enable_if< std::is_same< T, std::nullptr_t >::value >::type *=nullptr)
	Nullptr constructor. Declared as template to resolve priorities with other template constructors. More...
template<typename T >
	String (T &value, typename std::enable_if< IsStringLiteral< T, wchar_t >::value >::type *=nullptr)
	Constructs string based on widestring literal. Considers literal a null-terminated string, calculates target string length based on literal size. Conversion from wchar_t is time-consuming on some platforms, so no implicit conversions are allowed. More...
template<typename T >
	String (const T &value, typename std::enable_if< IsStringPointer< T, wchar_t >::value >::type *=nullptr)
	Constructs string based on widecharacter string pointer. Treats pointed string as null-terminated, calculates target string length based on null character. Conversion from wchar_t is time-consuming on some platforms, so no implicit conversions are allowed. More...
	String (const wchar_t *str, int length)
	Constructs string from widecharacter string pointer and explicit length. Conversion from wchar_t is time-consuming on some platforms, so no implicit conversions are allowed. More...
	String (const wchar_t ch, int count=1)
	Fill constructor. Conversion from wchar_t is time-consuming on some platforms, so no implicit conversions are allowed. More...
	String (const String &str)
	Copy constructor. More...
	String (String &&str) noexcept
	Move constructor. More...
	String (const ArrayPtr< char16_t > &arr)
	Converts whole character array to string. More...
	String (const ArrayPtr< char16_t > &arr, int offset, int len)
	Converts character array subrange to string. If parameters are out of array bounds, empty string is constructed. More...
	~String ()
	Destructor. More...
const UChar *	u_str () const
	Returns ICU-styled null-terminated buffer. May reallocate the string. More...
const UChar *	begin () const
	Returns pointer to the beginning of actual string buffer. Never reallocates anything. Doesn't guarantee buffer to be null-terminated. More...
const UChar *	end () const
	Returns pointer to the end of actual string buffer. Never reallocates anything. Doesn't guarantee buffer to be null-terminated. More...
reverse_iterator	rbegin () const
	Returns reverse iterator to the last character (if any) of actual string buffer. More...
reverse_iterator	rend () const
	Returns reverse iterator to the before first character (if any) of actual string buffer. More...
bool	IsNullOrEmpty () const
	Checks if string is empty or is considered null. More...
bool	IsNull () const
	Checks if string is considered null. String is null and only if it is constructed via String() constructor, moved, copied or assigned from null string or reset() method was called. More...
bool	IsEmpty () const
	Checks if string is both non-null and empty. More...
std::string	ToUtf8String () const
	Converts string to std::string. Uses UTF-8 encoding. More...
std::wstring	ToWCS () const
	Converts string to std::wstring. More...
std::u16string	ToU16Str () const
	Converts string to std::u16string. More...
std::u32string	ToU32Str () const
	Converts string to std::u32string. More...
std::string	ToAsciiString () const
	Converts string to std::string. Uses ASCII encoding. More...
String &	reset ()
	Sets string to null. Is analogous to 'string_variable_name = null' in C#. More...
int	get_Length () const
	Gets string length. More...
char_t	operator[] (int index) const
	Gets character at specified position. More...
String &	SetCharAt (int index, char_t ch)
	Sets character at specified position. More...
String &	operator= (const String &str)
	Assignment operator. More...
String &	operator= (String &&str) noexcept
	Move assignment operator. More...
String	operator+ (const String &str) const
	String concatenation operator. More...
template<typename T , std::enable_if_t< IsStringLiteral< T, char_t >::value > * = nullptr>
String	operator+ (const T &arg) const
	String concatenation with string literal or character string pointer. More...
String	operator+ (char_t x) const
	Adds character to the end of the string. More...
String	operator+ (int i) const
	Adds integer value string representation to the end of the string. More...
String	operator+ (uint32_t i) const
	Adds unsigned integer value string representation to the end of the string. More...
String	operator+ (double d) const
	Adds floating point value string representation to the end of the string. More...
String	operator+ (int64_t v) const
	Adds integer value string representation to the end of the string. More...
template<typename T , std::enable_if_t< IsSmartPtr< T >::value > * = nullptr>
String	operator+ (const T &value) const
	Adds reference type object string representation to the end of the string. More...
template<typename T , std::enable_if_t<!IsSmartPtr< T >::value &&!std::is_scalar< T >::value &&!std::is_array< T >::value > * = nullptr>
String	operator+ (const T &value) const
	Adds value type object string representation to the end of the string. More...
template<typename T , std::enable_if_t< std::is_same< T, bool >::value > * = nullptr>
String	operator+ (T arg) const
	Adds boolean value string representation to the end of the string. More...
String &	operator+= (char_t c)
	Concatenation assignment operator. More...
String &	operator+= (const String &str)
	Concatenation assignment operator. More...
String &	operator+= (double value)
	Concatenation assignment operator. More...
String &	operator+= (uint8_t value)
	Concatenation assignment operator. More...
String &	operator+= (int16_t value)
	Concatenation assignment operator. More...
String &	operator+= (uint16_t value)
	Concatenation assignment operator. More...
String &	operator+= (int32_t value)
	Concatenation assignment operator. More...
String &	operator+= (uint32_t value)
	Concatenation assignment operator. More...
String &	operator+= (int64_t value)
	Concatenation assignment operator. More...
String &	operator+= (uint64_t value)
	Concatenation assignment operator. More...
template<typename T , std::enable_if_t< std::is_same< T, bool >::value > * = nullptr>
String &	operator+= (T value)
	Concatenation assignment operator. More...
bool	operator== (const String &str) const
	Equality comparison operator. More...
bool	operator== (std::nullptr_t) const
	Checks if string is null. Applies same logic as IsNull() call. More...
bool	operator!= (const String &str) const
	Non-equality comparison operator. More...
bool	operator!= (std::nullptr_t) const
	Checks if string is not null. Applies same logic as IsNull() call. More...
bool	operator< (const String &str) const
	Order-compares strings. More...
String	Clone () const
	Creates a copy of current string. More...
String	ToString () const
	Wrapper for handling String class in contexts where ToString() is being called on value type objects. More...
String	ToString (const SharedPtr< IFormatProvider > &) const
	Wrapper for handling String class in contexts where ToString() is being called on value type objects. More...
int	GetHashCode () const
	Hashes contained string. Implemented in ICU, doesn't match hashes in C#. More...
bool	Equals (const String &str, System::StringComparison comparison_type) const
	String equality comparison. Several modes provided by StringComparison enumeration are supported. More...
bool	Equals (const String &str) const
	String equality comparison. Uses System::StringComparison::Ordinal comparison mode. More...
bool	Contains (const String &str) const
	Checks if str is a substring of current string. More...
int	CompareTo (const String &str) const
	Compares two strings in 'less-equals-more' style. Uses current culture. More...
void	CopyTo (int sourceIndex, const ArrayPtr< char_t > &destination, int destinationIndex, int count) const
	Copies string characters into existing array elements. No resize is being done. More...
String	Normalize (System::Text::NormalizationForm form) const
	Normalizes unicode string using normalization form specified. More...
bool	IsNormalized (System::Text::NormalizationForm form) const
	Checks if unicode string is normalized using normalization form specified. More...
bool	StartsWith (const String &value) const
	Checks if string begins with specified substring. More...
bool	StartsWith (const String &value, System::StringComparison comparisonType) const
	Checks if string begins with specified substring. More...
bool	StartsWith (const String &value, bool ignoreCase, const SharedPtr< System::Globalization::CultureInfo > &culture=nullptr) const
	Checks if string begins with specified substring. More...
bool	EndsWith (const String &value) const
	Checks if string ends with specified substring. More...
bool	EndsWith (const String &value, System::StringComparison comparisonType) const
	Checks if string ends with specified substring. More...
bool	EndsWith (const String &value, bool ignoreCase, const SharedPtr< System::Globalization::CultureInfo > &culture=nullptr) const
	Checks if string ends with specified substring. More...
ArrayPtr< char_t >	ToCharArray (int32_t startIndex=0, int32_t length=INT32_MAX) const
	Converts string or substring to array of characters. More...
ArrayPtr< uint8_t >	ToByteArray (int32_t startIndex=0, int32_t length=INT32_MAX, bool LE=true) const
	Converts string or substring to array of bytes. More...
String	ToUpper () const
	Converts all string's characters to upper case. More...
String	ToLower () const
	Converts all string's characters to lower case. More...
String	ToLower (const SharedPtr< System::Globalization::CultureInfo > &cultureInfo) const
	Converts all string's characters to lower case using specific culture. More...
String	ToUpper (const SharedPtr< System::Globalization::CultureInfo > &cultureInfo) const
	Converts all string's characters to upper case using specific culture. More...
String	ToUpperInvariant () const
	Converts all string's characters to upper case using invariant culture. More...
String	ToLowerInvariant () const
	Converts all string's characters to lower case using invariant culture. More...
String	Substring (int32_t startIndex) const
	Extracts substring. More...
String	Substring (int32_t startIndex, int32_t length) const
	Extracts substring. More...
String	Remove (int32_t startIndex, int32_t count=INT32_MAX) const
	Extracts everything but substring from current string. More...
bool	Is (const System::TypeInfo &target) const
	Checks if string object is of type specified by TypeInfo passed. More...
int	IndexOf (const String &str, System::StringComparison comparison_type) const
	Substring forward lookup. More...
int	IndexOf (char_t c, int startIndex=0) const
	Character forward lookup. More...
int	IndexOf (char_t c, int startIndex, int count) const
	Character forward lookup in substring. More...
int	IndexOf (const String &str, int startIndex=0) const
	Substring forward lookup. More...
int	IndexOf (const String &str, int startIndex, System::StringComparison comparison_type) const
	Substring forward lookup. More...
int	IndexOf (const String &value, int startIndex, int count, System::StringComparison comparisonType) const
	Substring forward lookup. More...
int	IndexOf (const String &str, int startIndex, int count) const
	Substring forward lookup. More...
int	IndexOfAny (char_t c, int startIndex=0) const
	Character forward lookup. More...
int	IndexOfAny (const String &str, int startIndex=0) const
	Consequently looks for all characters of str in this. If first character is found, its position is returned, otherwise looks for the second one and so on. More...
int	IndexOfAny (const ArrayPtr< char_t > &anyOf) const
	Looks for any of passed characters through the whole string. Compares first string character to all characters in anyOf, then compares second one and so on. Returns index of the first one matching any of the target characters. More...
int	IndexOfAny (const ArrayPtr< char_t > &anyOf, int32_t startindex) const
	Looks for any of passed characters through substring. Compares first string character to all characters in anyOf, then compares second one and so on. Returns index of the first one matching any of the target characters. More...
int	IndexOfAny (const ArrayPtr< char_t > &anyOf, int32_t startindex, int32_t count) const
	Looks for any of passed characters through substring. Compares first string character to all characters in anyOf, then compares second one and so on. Returns index of the first one matching any of the target characters. More...
int	LastIndexOf (const String &str, int startIndex=INT32_MAX) const
	Substring backward lookup. More...
int	LastIndexOf (const String &str, System::StringComparison comparison_type) const
	Substring backward lookup. More...
int	LastIndexOf (const String &str, int startIndex, System::StringComparison comparison_type) const
	Substring backward lookup. More...
int	LastIndexOf (const String &value, int startIndex, int count, StringComparison comparisonType) const
	Substring backward lookup. More...
int	LastIndexOf (char_t value) const
	Character backward lookup. More...
int	LastIndexOf (char_t value, int32_t startIndex) const
	Character backward lookup. More...
int	LastIndexOf (char_t value, int32_t startIndex, int32_t count) const
	Character backward lookup. More...
int	LastIndexOfAny (const ArrayPtr< char_t > &anyOf) const
	Looks for any of passed characters through whole string backwardly. Compares last string character to all characters in anyOf, then compares previous one and so on. Returns index of the first match found. More...
int	LastIndexOfAny (const ArrayPtr< char_t > &anyOf, int32_t startindex) const
	Looks for any of passed characters through substring backwardly. Compares last string character to all characters in anyOf, then compares previous one and so on. Returns index of the first match found. More...
int	LastIndexOfAny (const ArrayPtr< char_t > &anyOf, int32_t startindex, int32_t count) const
	Looks for any of passed characters through substring backwardly. Compares last string character to all characters in anyOf, then compares previous one and so on. Returns index of the first match found. More...
String	Trim () const
	Removes all whitespace characters from both beginning and end of the string. More...
String	Trim (char_t ch) const
	Removes all occurrences of passed character from both beginning and end of the string. More...
String	Trim (const String &anyOf) const
	Removes all occurrences of passed characters from both beginning and end of the string. More...
String	Trim (const ArrayPtr< char_t > &anyOf) const
	Removes all occurrences of passed characters from both beginning and end of the string. More...
String	TrimStart () const
	Removes all whitespace characters from beginning of the string. More...
String	TrimStart (char_t ch) const
	Removes all occurrences of passed character from beginning of the string. More...
String	TrimStart (const String &anyOf) const
	Removes all occurrences of passed characters from beginning of the string. More...
String	TrimStart (const ArrayPtr< char_t > &anyOf) const
	Removes all occurrences of passed characters from beginning of the string. More...
String	TrimEnd () const
	Removes all whitespace characters from end of the string. More...
String	TrimEnd (char_t ch) const
	Removes all occurrences of passed character from end of the string. More...
String	TrimEnd (const String &anyOf) const
	Removes all occurrences of passed characters from end of the string. More...
String	TrimEnd (const ArrayPtr< char_t > &anyOf) const
	Removes all occurrences of passed characters from end of the string. More...
String	PadLeft (int totalWidth, char_t c=u' ') const
	Adds padding on the left of original string. More...
String	PadRight (int totalWidth, char_t c=u' ') const
	Adds padding on the right of original string. More...
String	Replace (char_t oldValue, char_t newValue) const
	Replaces all occurrences of character in the string. More...
String	Replace (const String &oldValue, const String &newValue) const
	Replaces all occurrences of lookup in this string. More...
String	Insert (int startIndex, const String &value) const
	Inserts substring at specified position. More...
ArrayPtr< String >	Split (char_t separator=u' ', StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by character. More...
ArrayPtr< String >	Split (char_t separator, int32_t count, StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by character. More...
ArrayPtr< String >	Split (char_t separatorA, char_t separatorB, StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by one of two characters. More...
ArrayPtr< String >	Split (const ArrayPtr< char_t > &separators, StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by one of characters specified. More...
ArrayPtr< String >	Split (const ArrayPtr< char_t > &separators, int32_t count, StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by one of characters specified. More...
ArrayPtr< String >	Split (const String &separator, StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by substring. More...
ArrayPtr< String >	Split (const String &separator, int count, StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by substring. More...
ArrayPtr< String >	Split (const ArrayPtr< String > &separators, StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by substring. More...
ArrayPtr< String >	Split (const ArrayPtr< String > &separators, int count, StringSplitOptions opt=StringSplitOptions::None) const
	Splits string by substring. Currently, only supports separators array of zero or one elements. More...
	String (const codeporting_icu::UnicodeString &str)
	Wraps UnicodeString into String. More...
	String (codeporting_icu::UnicodeString &&str) noexcept
	Move constructor. More...
	String (const std::wstring &str)
	Creates String from widestring. More...
	String (const std::u16string &str)
	Creates String from utf16 string. More...
	String (const std::string &utf8str)
	Creates String from std::string string presented in format UTF-8. More...
	String (const std::u32string &u32str)
	Creates String from std::u32string string. More...
bool	IsAsciiString () const
	Indicates if a String contains ASCII symbols only. More...
int	FastToAscii (char buffer[], int buffer_size) const
	Tries to convert a String to an ASCII string. More...

Static Public Member Functions
static bool	IsNullOrEmpty (const String &str)
	Checks if passed string is null or empty. More...
static bool	IsNullOrWhiteSpace (const String &str)
	Indicates whether a specified string is null, empty, or consists only of white-space characters. More...
static bool	Equals (const String &strA, const String &strB)
	Equal-compares two strings using Ordial comparison mode. More...
static bool	Equals (const String &strA, const String &strB, System::StringComparison comparison_type)
	Equal-compares two strings. More...
static int	Compare (const String &strA, int indexA, const String &strB, int indexB, int length, bool ignoreCase=false)
	Less-equal-greater-compares two substrings. More...
static int	Compare (const String &strA, int indexA, const String &strB, int indexB, int length, bool ignoreCase, const SharedPtr< System::Globalization::CultureInfo > &ci)
	Less-equal-greater-compares two substrings. More...
static int	Compare (const String &strA, const String &strB, System::StringComparison comparison_type)
	Less-equal-greater-compares two strings. More...
static int	Compare (const String &strA, int indexA, const String &strB, int indexB, int length, System::StringComparison comparison_type)
	Less-equal-greater-compares two strings. More...
static int	Compare (const String &strA, const String &strB, bool ignoreCase=false)
	Less-equal-greater-compares two strings. More...
static int	Compare (const String &strA, const String &strB, bool ignoreCase, const SharedPtr< System::Globalization::CultureInfo > &ci)
	Less-equal-greater-compares two strings. More...
static int	CompareOrdinal (const String &strA, const String &strB)
	Less-equal-greater-compares two strings using ordinal mode. More...
static int	CompareOrdinal (const String &strA, int indexA, const String &strB, int indexB, int length)
	Less-equal-greater-compares two strings using ordinal mode. More...
static String	Join (const String &separator, const ArrayPtr< String > &parts, int startIndex=0, int count=-1)
	Joins array using string as separator. More...
static String	Join (const String &separator, const System::Details::ArrayView< String > &parts, int startIndex=0, int count=-1)
	Joins array using string as separator. More...
static String	Join (const String &separator, const SharedPtr< System::Collections::Generic::IEnumerable< String > > &parts)
	Joins array using string as separator. More...
static String	Join (const String &separator, const ArrayPtr< SharedPtr< Object > > &parts)
	Joins array using string as separator. More...
static String	Concat (const ArrayPtr< String > &parts)
	Concatenates strings. More...
static String	Concat (const String &str0, const String &str1)
	Concatenates strings. More...
static String	Concat (const String &str0, const String &str1, const String &str2)
	Concatenates strings. More...
static String	Concat (const String &str0, const String &str1, const String &str2, const String &str3)
	Concatenates strings. More...
static String	Copy (const String &str)
	Creates string copy. More...
template<class... Args>
static String	Format (const SharedPtr< IFormatProvider > &fp, const String &format, const Args &... args)
	Formats string in C# style. More...
template<class... Args>
static String	Format (std::nullptr_t, const String &format, const Args &... args)
	Formats string in C# style. More...
template<std::size_t N, class... Args>
static String	Format (std::nullptr_t, const char16_t(&format)[N], const Args &... args)
	Formats string in C# style. More...
template<class... Args>
static String	Format (const String &format, const Args &... args)
	Formats string in C# style. More...
template<class T >
static String	Format (const String &format, const System::ArrayPtr< T > &args)
	Formats string in C# style. More...
static String	FromUtf8 (const char *utf8)
	Creates String from utf8 string. More...
static String	FromUtf8 (const char *utf8, int len)
	Creates String from utf8 string. More...
static String	FromUtf8 (const uint8_t *utf8)
	Creates String from utf8 string. More...
static String	FromUtf8 (const std::string &utf8)
	Creates String from utf8 string. More...
static String	FromWCS (const std::wstring &wcs)
	Creates String from widestring. More...
static String	FromUtf32 (const uint32_t *utf32, int32_t length)
	Creates String from utf32 string. More...
static String	FromUtf16 (const std::u16string &u16str)
	Creates String from utf16 string. More...
static String	FromAscii (const char *asciiStr)
	Creates String from ASCII string. More...
static String	FromAscii (const char *asciiStr, int len)
	Creates String from ASCII string. More...
static String	FromAscii (const std::string &asciiStr)
	Creates String from ASCII string. More...

Static Public Attributes
static const String	Empty
	Empty string. More...
static const String	Null
	Null string. More...

Protected Member Functions
String &	Append (const char16_t *src, int32_t startIndex, int32_t count)
	Puts some characters into string. Changes string size. More...

Protected Attributes
Detail::UnicodeStringHolder	m_str
	Actual string value. More...
uintptr_t	m_state
	String state. Contains value 0 if string is null, 1 if string is constructed from string literal. More...

Detailed Description

String class used across the library. Is a substitute for C# System.String when translating code. For optimization reasons, isn't considered an Object subclass. This type should be allocated on stack and passed to functions by value or by reference. Never use System::SmartPtr class to manage objects of this type.

#include "system/string.h"
#include <iostream>
 
int main()
{
  // Construct a string from the array of characters and print it.
  const auto chars = {u'h', u'e', u'l', u'l', u'o'};
  const System::String string1(chars);
  std::cout << string1 << std::endl;
 
  // Construct a string from the array of bytes and print it.
  const uint8_t bytes[] = {0x77, 0x6f, 0x72, 0x6c, 0x64, 0x0};
  const auto string2 = System::String::FromUtf8(bytes);
  std::cout << string2 << std::endl;
 
  // Trim the string below and print it.
  const System::String string3(u"   This string contains whitespaces in the beginning and at the end.   ");
  std::cout << '"' << string3.Trim() << '"' << std::endl;
 
  // Print the number of words in the .
  std::cout << "Number of words: " << string3.Trim().Split(' ')->get_Length() << std::endl;
 
  return 0;
}
/*
This code example produces the following output:
hello
world
"This string contains whitespaces in the beginning and at the end."
Number of words: 11
*/

Member Typedef Documentation

reverse_iterator

using System::String::reverse_iterator = std::reverse_iterator<const char16_t*>

Reverse iterator type.

Constructor & Destructor Documentation

String() [1/24]

System::String::String

(

)

Default constructor. Creates string object which is considered null.

String() [2/24]

template<typename T >

System::String::String ( T &  value, typename std::enable_if< IsStringLiteral< T, char16_t >::value >::type *  = nullptr  )

inline

Constructs string based on string literal. Considers literal a null-terminated string, calculates target string length based on literal size.

Parameters

value

String literal pointer.

String() [3/24]

template<typename T >

System::String::String ( const T &  value, typename std::enable_if< IsStringPointer< T, char16_t >::value >::type *  = nullptr  )

inline

Constructs string based on character string pointer. Treats pointed string as null-terminated, calculates target string length based on null character.

Parameters

value

Character string pointer.

String() [4/24]

template<typename T >

System::String::String ( T &  value, typename std::enable_if< IsStringLiteral< T, char >::value >::type *  = nullptr  )

inlineexplicit

Constructs string based on string literal. Considers literal a null-terminated string in UTF8, calculates target string length based on literal size.

Parameters

value

String literal pointer.

String() [5/24]

template<typename T >

System::String::String ( const T &  value, typename std::enable_if< IsStringPointer< T, char >::value >::type *  = nullptr  )

inlineexplicit

Constructs string based on character string pointer. Treats pointed string as null-terminated in UTF8, calculates target string length based on null character.

Parameters

value

Character string pointer.

String() [6/24]

System::String::String	(	const char16_t *	str,
		int	length
	)

Constructs string from character string pointer and explicit length.

Parameters

str	String pointer, may be literal or array.
length	Explicit string length

String() [7/24]

System::String::String	(	const char *	str,
		int	length
	)

Constructs string from character string pointer and explicit length.

Parameters

str	String pointer to the UTF8 data, may be literal or array.
length	Explicit string length

String() [8/24]

System::String::String	(	const char16_t *	str,
		int	start,
		int	length
	)

Constructs string from character string pointer from starting position using length.

Parameters

str	String pointer, may be literal or array.
start	Starting position.
length	String length.

String() [9/24]

System::String::String ( const char16_t  ch, int  count  )

explicit

Fill constructor.

Parameters

ch	Fill character.
count	Target length.

String() [10/24]

template<typename T >

System::String::String ( const T &  value, typename std::enable_if< std::is_same< T, std::nullptr_t >::value >::type *  = nullptr  )

inline

Nullptr constructor. Declared as template to resolve priorities with other template constructors.

Template Parameters

T	Should be nullptr_t

Parameters

value

nullptr

String() [11/24]

template<typename T >

System::String::String ( T &  value, typename std::enable_if< IsStringLiteral< T, wchar_t >::value >::type *  = nullptr  )

inlineexplicit

Constructs string based on widestring literal. Considers literal a null-terminated string, calculates target string length based on literal size. Conversion from wchar_t is time-consuming on some platforms, so no implicit conversions are allowed.

Parameters

value

String literal pointer.

String() [12/24]

template<typename T >

System::String::String ( const T &  value, typename std::enable_if< IsStringPointer< T, wchar_t >::value >::type *  = nullptr  )

inlineexplicit

Constructs string based on widecharacter string pointer. Treats pointed string as null-terminated, calculates target string length based on null character. Conversion from wchar_t is time-consuming on some platforms, so no implicit conversions are allowed.

Parameters

value

Character string pointer.

String() [13/24]

System::String::String ( const wchar_t *  str, int  length  )

explicit

Constructs string from widecharacter string pointer and explicit length. Conversion from wchar_t is time-consuming on some platforms, so no implicit conversions are allowed.

Parameters

str	String pointer, may be literal or array.
length	Explicit string length

String() [14/24]

System::String::String ( const wchar_t  ch, int  count = 1  )

explicit

Fill constructor. Conversion from wchar_t is time-consuming on some platforms, so no implicit conversions are allowed.

Parameters

ch	Fill character.
count	Target length.

String() [15/24]

System::String::String

(

const String &

str

)

Copy constructor.

Parameters

str	String to copy.

String() [16/24]

System::String::String ( String &&  str )

noexcept

Move constructor.

Parameters

str	String to move data from.

String() [17/24]

System::String::String

(

const ArrayPtr< char16_t > &

arr

)

Converts whole character array to string.

Parameters

arr	Array to convert to string.

String() [18/24]

System::String::String	(	const ArrayPtr< char16_t > &	arr,
		int	offset,
		int	len
	)

Converts character array subrange to string. If parameters are out of array bounds, empty string is constructed.

Parameters

arr	Character array.
offset	Subarray start index.
len	Subarray length.

~String()

System::String::~String

(

)

Destructor.

String() [19/24]

System::String::String ( const codeporting_icu::UnicodeString &  str )

explicit

Wraps UnicodeString into String.

Parameters

str	UnicodeString to wrap into String.

String() [20/24]

System::String::String ( codeporting_icu::UnicodeString &&  str )

explicitnoexcept

Move constructor.

Parameters

str	UnicodeString to wrap into String.

String() [21/24]

System::String::String ( const std::wstring &  str )

inlineexplicit

Creates String from widestring.

Parameters

str	Widestring to convert into String.

String() [22/24]

System::String::String ( const std::u16string &  str )

inlineexplicit

Creates String from utf16 string.

Parameters

str	Utf16 string to convert into String.

String() [23/24]

System::String::String ( const std::string &  utf8str )

explicit

Creates String from std::string string presented in format UTF-8.

Parameters

utf8str

std::string string to convert into String.

String() [24/24]

System::String::String ( const std::u32string &  u32str )

explicit

Creates String from std::u32string string.

Parameters

u32str

std::u32string string to convert into String.

Member Function Documentation

Append()

String & System::String::Append ( const char16_t *  src, int32_t  startIndex, int32_t  count  )

protected

Puts some characters into string. Changes string size.

Parameters

src	Pointer to string to insert.
startIndex	Index to start insertion at.
count	Number of characters to insert.

begin()

const UChar * System::String::begin

(

)

const

Returns pointer to the beginning of actual string buffer. Never reallocates anything. Doesn't guarantee buffer to be null-terminated.

Returns

Pointer to actual string buffer, null-terminated or not.

Clone()

String System::String::Clone

(

)

const

Creates a copy of current string.

Returns

Full copy of current string which is never null.

Compare() [1/6]

static int System::String::Compare ( const String &  strA, const String &  strB, bool  ignoreCase, const SharedPtr< System::Globalization::CultureInfo > &  ci  )

static

Less-equal-greater-compares two strings.

Parameters

strA	First string to compare.
strB	Second string to compare.
ignoreCase	Specifies whether comparison is case-insensitive.
ci	Culture to use for comparison.

Returns

Negative value if first substring is less then second, zero if they match, positive value otherwise.

Compare() [2/6]

static int System::String::Compare ( const String &  strA, const String &  strB, bool  ignoreCase = false  )

static

Less-equal-greater-compares two strings.

Parameters

strA	First string to compare.
strB	Second string to compare.
ignoreCase	Specifies whether comparison is case-insensitive.

Returns

Negative value if first substring is less then second, zero if they match, positive value otherwise.

Compare() [3/6]

static int System::String::Compare ( const String &  strA, const String &  strB, System::StringComparison  comparison_type  )

static

Less-equal-greater-compares two strings.

Parameters

strA	First string to compare.
strB	Second string to compare.
comparison_type	Comparison mode.

Returns

Negative value if first substring is less then second, zero if they match, positive value otherwise.

Compare() [4/6]

static int System::String::Compare ( const String &  strA, int  indexA, const String &  strB, int  indexB, int  length, bool  ignoreCase, const SharedPtr< System::Globalization::CultureInfo > &  ci  )

static

Less-equal-greater-compares two substrings.

Parameters

strA	First string to compare.
indexA	Beginning of first string substring.
strB	Second string to compare.
indexB	Beginning of the second string substring.
length	Number of characters to compare.
ignoreCase	Specifies whether comparison is case-insensitive.
ci	Culture to use for comparison.

Returns

Negative value if first substring is less then second, zero if they match, positive value otherwise.

Compare() [5/6]

static int System::String::Compare ( const String &  strA, int  indexA, const String &  strB, int  indexB, int  length, bool  ignoreCase = false  )

static

Less-equal-greater-compares two substrings.

Parameters

strA	First string to compare.
indexA	Beginning of first string substring.
strB	Second string to compare.
indexB	Beginning of the second string substring.
length	Number of characters to compare.
ignoreCase	Specifies whether comparison is case-insensitive.

Returns

Negative value if first substring is less then second, zero if they match, positive value otherwise.

Compare() [6/6]

static int System::String::Compare ( const String &  strA, int  indexA, const String &  strB, int  indexB, int  length, System::StringComparison  comparison_type  )

static

Less-equal-greater-compares two strings.

Parameters

strA	First string to compare.
indexA	Beginning of first string substring.
strB	Second string to compare.
indexB	Beginning of the second string substring.
length	Number of characters to compare.
comparison_type	Comparison mode.

Returns

Negative value if first substring is less then second, zero if they match, positive value otherwise.

CompareOrdinal() [1/2]

static int System::String::CompareOrdinal ( const String &  strA, const String &  strB  )

static

Less-equal-greater-compares two strings using ordinal mode.

Parameters

strA	First string to compare.
strB	Second string to compare.

Returns

Negative value if first substring is less then second, zero if they match, positive value otherwise.

CompareOrdinal() [2/2]

static int System::String::CompareOrdinal ( const String &  strA, int  indexA, const String &  strB, int  indexB, int  length  )

static

Less-equal-greater-compares two strings using ordinal mode.

Parameters

strA	First string to compare.
indexA	Beginning of first string substring.
strB	Second string to compare.
indexB	Beginning of the second string substring.
length	Number of characters to compare.

Returns

Negative value if first substring is less then second, zero if they match, positive value otherwise.

CompareTo()

int System::String::CompareTo

(

const String &

str

)

const

Compares two strings in 'less-equals-more' style. Uses current culture.

Parameters

str	String to compare this to.

Returns

Negative value if this is considered lower than str, zero if they match, positive value if this is greater than str.

Concat() [1/4]

static String System::String::Concat ( const ArrayPtr< String > &  parts )

static

Concatenates strings.

Parameters

parts

Strings to concatenate.

Returns

String containing concatenated strings.

Concat() [2/4]

static String System::String::Concat ( const String &  str0, const String &  str1  )

static

Concatenates strings.

Parameters

str0	First string to concatenate.
str1	Second string to concatenate.

Returns

String containing concatenated strings.

Concat() [3/4]

static String System::String::Concat ( const String &  str0, const String &  str1, const String &  str2  )

static

Concatenates strings.

Parameters

str0	First string to concatenate.
str1	Second string to concatenate.
str2	Third string to concatenate.

Returns

String containing concatenated strings.

Concat() [4/4]

static String System::String::Concat ( const String &  str0, const String &  str1, const String &  str2, const String &  str3  )

static

Concatenates strings.

Parameters

str0	First string to concatenate.
str1	Second string to concatenate.
str2	Third string to concatenate.
str3	Fourth string to concatenate.

Returns

String containing concatenated strings.

Contains()

bool System::String::Contains

(

const String &

str

)

const

Checks if str is a substring of current string.

Parameters

str	Lookup string.

Returns

true if substring is present, false otherwise.

Copy()

static String System::String::Copy ( const String &  str )

inlinestatic

Creates string copy.

Parameters

str	String to copy.

Returns

Copy of passed string.

CopyTo()

void System::String::CopyTo	(	int	sourceIndex,
		const ArrayPtr< char_t > &	destination,
		int	destinationIndex,
		int	count
	)		const

Copies string characters into existing array elements. No resize is being done.

Parameters

sourceIndex	In-string index to start reading from.
destination	Destination array.
destinationIndex	In-array index to start writing from.
count	Number of characters to copy.

end()

const UChar * System::String::end

(

)

const

Returns pointer to the end of actual string buffer. Never reallocates anything. Doesn't guarantee buffer to be null-terminated.

Returns

Pointer to the first element after actual string buffer, null-terminated or not.

EndsWith() [1/3]

bool System::String::EndsWith

(

const String &

value

)

const

Checks if string ends with specified substring.

Parameters

value

Lookup string.

Returns

true if string ends with specified substring, false otherwise.

EndsWith() [2/3]

bool System::String::EndsWith	(	const String &	value,
		bool	ignoreCase,
		const SharedPtr< System::Globalization::CultureInfo > &	culture = nullptr
	)		const

Checks if string ends with specified substring.

Parameters

value	Lookup string.
ignoreCase	Specifies whether comparison is case-insensitive.
culture	Culture to use while performing string comparison.

Returns

true if string ends with specified substring, false otherwise.

EndsWith() [3/3]

bool System::String::EndsWith	(	const String &	value,
		System::StringComparison	comparisonType
	)		const

Checks if string ends with specified substring.

Parameters

value	Lookup string.
comparisonType	Comparison mode, see System::StringComparison for details.

Returns

true if string ends with specified substring, false otherwise.

Equals() [1/4]

bool System::String::Equals

(

const String &

str

)

const

String equality comparison. Uses System::StringComparison::Ordinal comparison mode.

Parameters

str	String to compare against the current one.

Returns

true if strings match, false otherwise.

Equals() [2/4]

bool System::String::Equals	(	const String &	str,
		System::StringComparison	comparison_type
	)		const

String equality comparison. Several modes provided by StringComparison enumeration are supported.

Parameters

str	String to compare against the current one.
comparison_type	Comparison mode (see System::StringComparison for details).

Returns

true if strings match using selected comparison type, false otherwise.

Equals() [3/4]

static bool System::String::Equals ( const String &  strA, const String &  strB  )

static

Equal-compares two strings using Ordial comparison mode.

Parameters

strA	First string to compare.
strB	Second string to compare.

Returns

true if strings match, false otherwise.

Equals() [4/4]

static bool System::String::Equals ( const String &  strA, const String &  strB, System::StringComparison  comparison_type  )

static

Equal-compares two strings.

Parameters

strA	First string to compare.
strB	Second string to compare.
comparison_type	Comparison mode.

Returns

true if strings match, false otherwise.

FastToAscii()

int System::String::FastToAscii	(	char	buffer[],
		int	buffer_size
	)		const

Tries to convert a String to an ASCII string.

Parameters

buffer	A buffer to store the resulting string.
buffer_size	Buffer's size.

Returns

The resulting string length or -1 if a String is not an ASCII string.

Format() [1/5]

template<class... Args>

String System::String::Format ( const SharedPtr< IFormatProvider > &  fp, const String &  format, const Args &...  args  )

static

Formats string in C# style.

Template Parameters

Args	Arguments to format string.

Parameters

fp	Format provider to use to convert arguments to strings.
format	Format string.
args	Arguments to format string.

Format() [2/5]

template<class... Args>

String System::String::Format ( const String &  format, const Args &...  args  )

static

Formats string in C# style.

Template Parameters

Args	Arguments to format string.

Parameters

format	Format string.
args	Arguments to format string.

Format() [3/5]

template<class T >

String System::String::Format ( const String &  format, const System::ArrayPtr< T > &  args  )

static

Formats string in C# style.

Template Parameters

T	Arguments to format string.

Parameters

format	Format string.
args	Arguments to format string.

Format() [4/5]

template<std::size_t N, class... Args>

String System::String::Format ( std::nullptr_t  , const char16_t(&)  format[N], const Args &...  args  )

static

Formats string in C# style.

Template Parameters

Args	Arguments to format string.

Parameters

format	Format string.
args	Arguments to format string.

Format() [5/5]

template<class... Args>

String System::String::Format ( std::nullptr_t  , const String &  format, const Args &...  args  )

static

Formats string in C# style.

Template Parameters

Args	Arguments to format string.

Parameters

format	Format string.
args	Arguments to format string.

FromAscii() [1/3]

static String System::String::FromAscii ( const char *  asciiStr )

static

Creates String from ASCII string.

Parameters

asciiStr

Pointer to null-terminated string encoded using ASCII codepage.

Returns

String object representing passed string.

FromAscii() [2/3]

static String System::String::FromAscii ( const char *  asciiStr, int  len  )

static

Creates String from ASCII string.

Parameters

asciiStr	Pointer to string encoded using ASCII codepage.
len	Number of characters to handle.

Returns

String object representing passed string.

FromAscii() [3/3]

static String System::String::FromAscii ( const std::string &  asciiStr )

static

Creates String from ASCII string.

Parameters

asciiStr

ASCII-encoded string.

Returns

String object representing passed string.

FromUtf16()

static String System::String::FromUtf16 ( const std::u16string &  u16str )

static

Creates String from utf16 string.

Parameters

u16str

Utf16 string.

Returns

String object representing passed string.

FromUtf32()

static String System::String::FromUtf32 ( const uint32_t *  utf32, int32_t  length  )

static

Creates String from utf32 string.

Parameters

utf32	Pointer to string encoded in utf32.
length	Number of characters to convert.

Returns

String object representing passed string.

FromUtf8() [1/4]

static String System::String::FromUtf8 ( const char *  utf8 )

static

Creates String from utf8 string.

Parameters

utf8	Pointer to null-terminated string encoded using utf8 codepage.

Returns

String object representing passed string.

FromUtf8() [2/4]

static String System::String::FromUtf8 ( const char *  utf8, int  len  )

static

Creates String from utf8 string.

Parameters

utf8	Pointer to string encoded using utf8 codepage.
len	Number of characters to handle.

Returns

String object representing passed string.

FromUtf8() [3/4]

static String System::String::FromUtf8 ( const std::string &  utf8 )

static

Creates String from utf8 string.

Parameters

utf8	Pointer to string encoded using utf8 codepage.

Returns

String object representing passed string.

FromUtf8() [4/4]

static String System::String::FromUtf8 ( const uint8_t *  utf8 )

static

Creates String from utf8 string.

Parameters

utf8	Pointer to null-terminated string encoded using utf8 codepage.

Returns

String object representing passed string.

FromWCS()

static String System::String::FromWCS ( const std::wstring &  wcs )

static

Creates String from widestring.

Parameters

wcs	Widestring to convert into String.

Returns

String object representing passed string.

get_Length()

int System::String::get_Length

(

)

const

Gets string length.

Returns

Length of contained string.

GetHashCode()

int System::String::GetHashCode

(

)

const

Hashes contained string. Implemented in ICU, doesn't match hashes in C#.

Returns

Calculated hash code value.

IndexOf() [1/7]

int System::String::IndexOf	(	char_t	c,
		int	startIndex,
		int	count
	)		const

Character forward lookup in substring.

Parameters

c	Character to look for.
startIndex	Index to start lookup at.
count	Number of characters to look through.

Returns

Index of first character position since startIndex or -1 if not found.

IndexOf() [2/7]

int System::String::IndexOf	(	char_t	c,
		int	startIndex = 0
	)		const

Character forward lookup.

Parameters

c	Character to look for.
startIndex	Index to start lookup at.

Returns

Index of first character position since startIndex or -1 if not found.

IndexOf() [3/7]

int System::String::IndexOf	(	const String &	str,
		int	startIndex,
		int	count
	)		const

Substring forward lookup.

Parameters

str	Substring to look for.
startIndex	Position in source string to start lookup through.
count	number of characters to look through.

Returns

Index of first found substring or -1 if not found. For empty lookup string, always returns startIndex.

IndexOf() [4/7]

int System::String::IndexOf	(	const String &	str,
		int	startIndex,
		System::StringComparison	comparison_type
	)		const

Substring forward lookup.

Parameters

str	Substring to look for.
startIndex	Position in source string to start lookup through.
comparison_type	Comparison mode.

Returns

Index of first found substring or -1 if not found. For empty lookup string, always returns startIndex.

IndexOf() [5/7]

int System::String::IndexOf	(	const String &	str,
		int	startIndex = 0
	)		const

Substring forward lookup.

Parameters

str	Substring to look for.
startIndex	Position in source string to start lookup through.

Returns

Index of first found substring or -1 if not found. For empty lookup string, always returns startIndex.

IndexOf() [6/7]

int System::String::IndexOf	(	const String &	str,
		System::StringComparison	comparison_type
	)		const

Substring forward lookup.

Parameters

str	Substring to look for.
comparison_type	Comparison mode.

Returns

Index of first found substring or -1 if not found. For empty lookup string, always returns 0.

IndexOf() [7/7]

int System::String::IndexOf	(	const String &	value,
		int	startIndex,
		int	count,
		System::StringComparison	comparisonType
	)		const

Substring forward lookup.

Parameters

value	Substring to look for.
startIndex	Position in source string to start lookup through.
count	number of characters to look through.
comparisonType	Comparison mode.

Returns

Index of first found substring or -1 if not found. For empty lookup string, always returns startIndex.

IndexOfAny() [1/5]

int System::String::IndexOfAny	(	char_t	c,
		int	startIndex = 0
	)		const

Character forward lookup.

Parameters

c	Character to look for.
startIndex	Index to start lookup at.

Returns

Index of first character position since startIndex or -1 if not found.

IndexOfAny() [2/5]

int System::String::IndexOfAny

(

const ArrayPtr< char_t > &

anyOf

)

const

Looks for any of passed characters through the whole string. Compares first string character to all characters in anyOf, then compares second one and so on. Returns index of the first one matching any of the target characters.

Parameters

anyOf

Array of characters to look for. Order doesn't matter.

Returns

Index of the first matching character or -1 if not found.

IndexOfAny() [3/5]

int System::String::IndexOfAny	(	const ArrayPtr< char_t > &	anyOf,
		int32_t	startindex
	)		const

Looks for any of passed characters through substring. Compares first string character to all characters in anyOf, then compares second one and so on. Returns index of the first one matching any of the target characters.

Parameters

anyOf	Array of characters to look for. Order doesn't matter.
startindex	Index to start lookup from.

Returns

Index of the first matching character or -1 if not found.

IndexOfAny() [4/5]

int System::String::IndexOfAny	(	const ArrayPtr< char_t > &	anyOf,
		int32_t	startindex,
		int32_t	count
	)		const

Looks for any of passed characters through substring. Compares first string character to all characters in anyOf, then compares second one and so on. Returns index of the first one matching any of the target characters.

Parameters

anyOf	Array of characters to look for. Order doesn't matter.
startindex	Index to start lookup from.
count	Number of characters to look through.

Returns

Index of the first matching character or -1 if not found.

IndexOfAny() [5/5]

int System::String::IndexOfAny	(	const String &	str,
		int	startIndex = 0
	)		const

Consequently looks for all characters of str in this. If first character is found, its position is returned, otherwise looks for the second one and so on.

Parameters

str	String of characters to look for. Order of characters matters.
startIndex	Position to start lookup from.

Returns

Index of first found character or -1 if none is found.

Insert()

String System::String::Insert	(	int	startIndex,
		const String &	value
	)		const

Inserts substring at specified position.

Parameters

startIndex	Index in this string to start inserting from.
value	Insertion string.

Returns

String with insertion done.

Is()

bool System::String::Is ( const System::TypeInfo &  target ) const

inline

Checks if string object is of type specified by TypeInfo passed.

Parameters

target

TypeInfo to check against.

Returns

true if target is TypeInfo of String class, false otherwise.

IsAsciiString()

bool System::String::IsAsciiString

(

)

const

Indicates if a String contains ASCII symbols only.

Returns

True if a string is an ASCII string.

IsEmpty()

bool System::String::IsEmpty

(

)

const

Checks if string is both non-null and empty.

Returns

true if string is empty and not null, false otherwise.

IsNormalized()

bool System::String::IsNormalized

(

System::Text::NormalizationForm

form

)

const

Checks if unicode string is normalized using normalization form specified.

Parameters

form	Normalization form, see System::Text::NormalizationForm for details.

Returns

true if string is already normalized, false otherwise.

IsNull()

bool System::String::IsNull ( ) const

inline

Checks if string is considered null. String is null and only if it is constructed via String() constructor, moved, copied or assigned from null string or reset() method was called.

Returns

true if string is considered null, false otherwise.

IsNullOrEmpty() [1/2]

bool System::String::IsNullOrEmpty

(

)

const

Checks if string is empty or is considered null.

Returns

true if string is empty or null, false otherwise.

IsNullOrEmpty() [2/2]

static bool System::String::IsNullOrEmpty ( const String &  str )

static

Checks if passed string is null or empty.

Parameters

str	String to check.

Returns

true if string is null or empty, false otherwise.

IsNullOrWhiteSpace()

static bool System::String::IsNullOrWhiteSpace ( const String &  str )

static

Indicates whether a specified string is null, empty, or consists only of white-space characters.

Parameters

str	String to check.

Returns

true if string is null or empty or consists exclusively of white-space characters, false otherwise.

Join() [1/4]

static String System::String::Join ( const String &  separator, const ArrayPtr< SharedPtr< Object > > &  parts  )

static

Joins array using string as separator.

Parameters

separator	String to put between array elements when joining them.
parts	Array of parts to join.

Returns

String representing joint elements.

Join() [2/4]

static String System::String::Join ( const String &  separator, const ArrayPtr< String > &  parts, int  startIndex = 0, int  count = -1  )

static

Joins array using string as separator.

Parameters

separator	String to put between array elements when joining them.
parts	Array of parts to join.
startIndex	First index in array to start joining from.
count	Number of array elements to join. -1 means 'until array ends'.

Returns

String representing joint array elements.

Join() [3/4]

static String System::String::Join ( const String &  separator, const SharedPtr< System::Collections::Generic::IEnumerable< String > > &  parts  )

static

Joins array using string as separator.

Parameters

separator	String to put between array elements when joining them.
parts	- parts enumerable object

Returns

String representing joint elements.

Join() [4/4]

static String System::String::Join ( const String &  separator, const System::Details::ArrayView< String > &  parts, int  startIndex = 0, int  count = -1  )

static

Joins array using string as separator.

Parameters

separator	String to put between array elements when joining them.
parts	ArrayView of parts to join.
startIndex	First index in array to start joining from.
count	Number of array elements to join. -1 means 'until array ends'.

Returns

String representing joint array elements.

LastIndexOf() [1/7]

int System::String::LastIndexOf

(

char_t

value

)

const

Character backward lookup.

Parameters

value

Character to look for.

Returns

Index of last character position or -1 if not found.

LastIndexOf() [2/7]

int System::String::LastIndexOf	(	char_t	value,
		int32_t	startIndex
	)		const

Character backward lookup.

Parameters

value	Character to look for.
startIndex	Index to start lookup at.

Returns

Index of last character position since startIndex or -1 if not found.

LastIndexOf() [3/7]

int System::String::LastIndexOf	(	char_t	value,
		int32_t	startIndex,
		int32_t	count
	)		const

Character backward lookup.

Parameters

value	Character to look for.
startIndex	Index to start lookup at.
count	Number of characters to look through

Returns

Index of last character position since startIndex or -1 if not found.

LastIndexOf() [4/7]

int System::String::LastIndexOf	(	const String &	str,
		int	startIndex,
		System::StringComparison	comparison_type
	)		const

Substring backward lookup.

Parameters

str	Substring to look for.
startIndex	Position in source string to start lookup through.
comparison_type	Comparison mode.

Returns

Index of last found substring or -1 if not found. For empty lookup string, always returns string length.

LastIndexOf() [5/7]

int System::String::LastIndexOf	(	const String &	str,
		int	startIndex = INT32_MAX
	)		const

Substring backward lookup.

Parameters

str	Substring to look for.
startIndex	Position in source string to start lookup through.

Returns

Index of last found substring or -1 if not found. For empty lookup string, always returns string length.

LastIndexOf() [6/7]

int System::String::LastIndexOf	(	const String &	str,
		System::StringComparison	comparison_type
	)		const

Substring backward lookup.

Parameters

str	Substring to look for.
comparison_type	Comparison mode.

Returns

Index of last found substring or -1 if not found. For empty lookup string, always returns string length.

LastIndexOf() [7/7]

int System::String::LastIndexOf	(	const String &	value,
		int	startIndex,
		int	count,
		StringComparison	comparisonType
	)		const

Substring backward lookup.

Parameters

value	Substring to look for.
startIndex	Position in source string to start lookup through.
count	Number of characters to look through.
comparisonType	Comparison mode.

Returns

Index of last found substring or -1 if not found. For empty lookup string, always returns startIndex+count.

LastIndexOfAny() [1/3]

int System::String::LastIndexOfAny

(

const ArrayPtr< char_t > &

anyOf

)

const

Looks for any of passed characters through whole string backwardly. Compares last string character to all characters in anyOf, then compares previous one and so on. Returns index of the first match found.

Parameters

anyOf

Array of characters to look for. Order doesn't matter.

Returns

Index of the last matching character or -1 if not found.

LastIndexOfAny() [2/3]

int System::String::LastIndexOfAny	(	const ArrayPtr< char_t > &	anyOf,
		int32_t	startindex
	)		const

Looks for any of passed characters through substring backwardly. Compares last string character to all characters in anyOf, then compares previous one and so on. Returns index of the first match found.

Parameters

anyOf	Array of characters to look for. Order doesn't matter.
startindex	Index to start lookup from.

Returns

Index of the last matching character or -1 if not found.

LastIndexOfAny() [3/3]

int System::String::LastIndexOfAny	(	const ArrayPtr< char_t > &	anyOf,
		int32_t	startindex,
		int32_t	count
	)		const

Looks for any of passed characters through substring backwardly. Compares last string character to all characters in anyOf, then compares previous one and so on. Returns index of the first match found.

Parameters

anyOf	Array of characters to look for. Order doesn't matter.
startindex	Index to start lookup from.
count	Number of characters to look through.

Returns

Index of the last matching character or -1 if not found.

Normalize()

String System::String::Normalize

(

System::Text::NormalizationForm

form

)

const

Normalizes unicode string using normalization form specified.

Parameters

form	Normalization form, see System::Text::NormalizationForm for details.

Returns

Normalized string.

operator!=() [1/2]

bool System::String::operator!=

(

const String &

str

)

const

Non-equality comparison operator.

Parameters

str	String to compare current one to.

Returns

false if both strings are null or both are not null and match, true otherwise.

operator!=() [2/2]

bool System::String::operator!=

(

std::nullptr_t

)

const

Checks if string is not null. Applies same logic as IsNull() call.

Returns

false if string is null, true otherwise.

operator+() [1/10]

String System::String::operator+

(

char_t

x

)

const

Adds character to the end of the string.

Parameters

x	Character to add.

Returns

String concatenation result.

operator+() [2/10]

String System::String::operator+

(

const String &

str

)

const

String concatenation operator.

Parameters

str	String to add to the end of current one.

Returns

Concatenated string.

operator+() [3/10]

template<typename T , std::enable_if_t< IsStringLiteral< T, char_t >::value > * = nullptr>

String System::String::operator+ ( const T &  arg ) const

inline

String concatenation with string literal or character string pointer.

Template Parameters

T	One of string literal or character string pointer forms.

Parameters

arg	Entity to concatenate with current string.

Returns

Concatenated string.

operator+() [4/10]

template<typename T , std::enable_if_t< IsSmartPtr< T >::value > * = nullptr>

String System::String::operator+ ( const T &  value ) const

inline

Adds reference type object string representation to the end of the string.

Template Parameters

T	pointer type.

Parameters

value

Object to convert to string using ToString() call and to add to current string.

Returns

String concatenation result.

operator+() [5/10]

template<typename T , std::enable_if_t<!IsSmartPtr< T >::value &&!std::is_scalar< T >::value &&!std::is_array< T >::value > * = nullptr>

String System::String::operator+ ( const T &  value ) const

inline

Adds value type object string representation to the end of the string.

Template Parameters

T	Value type to call ToString() upon.

Parameters

value

Object to convert to string using ToString() call and to add to current string.

Returns

String concatenation result.

operator+() [6/10]

String System::String::operator+

(

double

d

)

const

Adds floating point value string representation to the end of the string.

Parameters

d	Value to convert to string and to add.

Returns

String concatenation result.

operator+() [7/10]

String System::String::operator+

(

int

i

)

const

Adds integer value string representation to the end of the string.

Parameters

i	Integer value to convert to string and to add.

Returns

String concatenation result.

operator+() [8/10]

String System::String::operator+

(

int64_t

v

)

const

Adds integer value string representation to the end of the string.

Parameters

v	Value to convert to string and to add to add.

Returns

String concatenation result.

operator+() [9/10]

template<typename T , std::enable_if_t< std::is_same< T, bool >::value > * = nullptr>

String System::String::operator+ ( T  arg ) const

inline

Adds boolean value string representation to the end of the string.

Template Parameters

T	Value type to concatenate with string. Must be bool

Parameters

arg	Boolean value to convert to string and to add.

Returns

String concatenation result.

operator+() [10/10]

String System::String::operator+

(

uint32_t

i

)

const

Adds unsigned integer value string representation to the end of the string.

Parameters

i	Value to convert to string and to add.

Returns

String concatenation result.

operator+=() [1/11]

String & System::String::operator+=

(

char_t

c

)

Concatenation assignment operator.

Parameters

c	Character to add to the end of current string.

Returns

self reference.

operator+=() [2/11]

String & System::String::operator+=

(

const String &

str

)

Concatenation assignment operator.

Parameters

str	String to add to the end of current string.

Returns

self reference.

operator+=() [3/11]

String & System::String::operator+=

(

double

value

)

Concatenation assignment operator.

Parameters

value

Double to add to the end of current string.

Returns

self reference.

operator+=() [4/11]

String & System::String::operator+=

(

int16_t

value

)

Concatenation assignment operator.

Parameters

value

Short to add to the end of current string.

Returns

self reference.

operator+=() [5/11]

String & System::String::operator+=

(

int32_t

value

)

Concatenation assignment operator.

Parameters

value

Int to add to the end of current string.

Returns

self reference.

operator+=() [6/11]

String & System::String::operator+=

(

int64_t

value

)

Concatenation assignment operator.

Parameters

value

Long to add to the end of current string.

Returns

self reference.

operator+=() [7/11]

template<typename T , std::enable_if_t< std::is_same< T, bool >::value > * = nullptr>

String & System::String::operator+= ( T  value )

inline

Concatenation assignment operator.

Template Parameters

T	Value type to concatenate with string. Must be bool

Parameters

value

Boolean to add to the end of current string.

Returns

self reference.

operator+=() [8/11]

String & System::String::operator+=

(

uint16_t

value

)

Concatenation assignment operator.

Parameters

value

Unsigned short to add to the end of current string.

Returns

self reference.

operator+=() [9/11]

String & System::String::operator+=

(

uint32_t

value

)

Concatenation assignment operator.

Parameters

value

Unsigned int to add to the end of current string.

Returns

self reference.

operator+=() [10/11]

String & System::String::operator+=

(

uint64_t

value

)

Concatenation assignment operator.

Parameters

value

Unsigned long to add to the end of current string.

Returns

self reference.

operator+=() [11/11]

String & System::String::operator+=

(

uint8_t

value

)

Concatenation assignment operator.

Parameters

value

Byte to add to the end of current string.

Returns

self reference.

operator<()

bool System::String::operator<

(

const String &

str

)

const

Order-compares strings.

Parameters

str	String to compare current one to.

Returns

true if this is considering less than str, false otherwise.

operator=() [1/2]

String & System::String::operator=

(

const String &

str

)

Assignment operator.

Parameters

str	String to copy.

Returns

Self reference.

operator=() [2/2]

String & System::String::operator= ( String &&  str )

noexcept

Move assignment operator.

Parameters

str	String to move data from.

Returns

Self reference.

operator==() [1/2]

bool System::String::operator==

(

const String &

str

)

const

Equality comparison operator.

Parameters

str	String to compare current one to.

Returns

true if both strings are null or both are not null and match, false otherwise.

operator==() [2/2]

bool System::String::operator==

(

std::nullptr_t

)

const

Checks if string is null. Applies same logic as IsNull() call.

Returns

true if string is null, false otherwise.

operator[]()

char_t System::String::operator[]

(

int

index

)

const

Gets character at specified position.

Parameters

index

Index to get character from.

Returns

Character at specified position or 0xffff if out of bounds.

PadLeft()

String System::String::PadLeft	(	int	totalWidth,
		char_t	c = u' '
	)		const

Adds padding on the left of original string.

Parameters

totalWidth	Number of padding characters to insert.
c	Padding character.

Returns

String with padding inserted.

PadRight()

String System::String::PadRight	(	int	totalWidth,
		char_t	c = u' '
	)		const

Adds padding on the right of original string.

Parameters

totalWidth	Number of padding characters to insert.
c	Padding character.

Returns

String with padding inserted.

rbegin()

reverse_iterator System::String::rbegin

(

)

const

Returns reverse iterator to the last character (if any) of actual string buffer.

Returns

Reverse iterator to the last character of actual string buffer (if any) or same as rend().

Remove()

String System::String::Remove	(	int32_t	startIndex,
		int32_t	count = INT32_MAX
	)		const

Extracts everything but substring from current string.

Parameters

startIndex	Index of first character to not extract.
count	Number of characters to not extract.

Returns

String around specified substring.

rend()

reverse_iterator System::String::rend

(

)

const

Returns reverse iterator to the before first character (if any) of actual string buffer.

Returns

Reverse iterator to the element preceding first character of actual string buffer (if any) or to element just before allocated buffer.

Replace() [1/2]

String System::String::Replace	(	char_t	oldValue,
		char_t	newValue
	)		const

Replaces all occurrences of character in the string.

Parameters

oldValue	Character to replace.
newValue	replacement value.

Returns

String with replacement done.

Replace() [2/2]

String System::String::Replace	(	const String &	oldValue,
		const String &	newValue
	)		const

Replaces all occurrences of lookup in this string.

Parameters

oldValue	String to replace.
newValue	replacement string.

Returns

String with replacement done.

reset()

String & System::String::reset

(

)

Sets string to null. Is analogous to 'string_variable_name = null' in C#.

Returns

Self reference.

SetCharAt()

String & System::String::SetCharAt	(	int	index,
		char_t	ch
	)

Sets character at specified position.

Parameters

index	Index to set character at.
ch	Character to put at specified position.

Returns

Self reference.

Split() [1/9]

ArrayPtr< String > System::String::Split	(	char_t	separator,
		int32_t	count,
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by character.

Parameters

separator	Character to split string by.
count	The maximum number of substrings to return.
opt	Splitting options.

Returns

Array of substrings.

Split() [2/9]

ArrayPtr< String > System::String::Split	(	char_t	separator = u' ',
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by character.

Parameters

separator	Character to split string by.
opt	Splitting options.

Returns

Array of substrings.

Split() [3/9]

ArrayPtr< String > System::String::Split	(	char_t	separatorA,
		char_t	separatorB,
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by one of two characters.

Parameters

separatorA	First character to split string by.
separatorB	Second character to split string by.
opt	Splitting options.

Returns

Array of substrings.

Split() [4/9]

ArrayPtr< String > System::String::Split	(	const ArrayPtr< char_t > &	separators,
		int32_t	count,
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by one of characters specified.

Parameters

separators	Array of separator characters. If empty, any whitespace character is considered a separator.
count	The maximum number of substrings to return.
opt	Splitting options.

Returns

Array of substrings.

Split() [5/9]

ArrayPtr< String > System::String::Split	(	const ArrayPtr< char_t > &	separators,
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by one of characters specified.

Parameters

separators	Array of separator characters. If empty, any whitespace character is considered a separator.
opt	Splitting options.

Returns

Array of substrings.

Split() [6/9]

ArrayPtr< String > System::String::Split	(	const ArrayPtr< String > &	separators,
		int	count,
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by substring. Currently, only supports separators array of zero or one elements.

Parameters

separators	Array of separator strings. If empty, no splitting is done.
count	Max number of elements in splits array.
opt	Splitting options.

Returns

Array of substrings.

Split() [7/9]

ArrayPtr< String > System::String::Split	(	const ArrayPtr< String > &	separators,
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by substring.

Parameters

separators	Array of separator strings. If empty, no splitting is done.
opt	Splitting options.

Returns

Array of substrings.

Split() [8/9]

ArrayPtr< String > System::String::Split	(	const String &	separator,
		int	count,
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by substring.

Parameters

separator	Substring acting as separator. If empty, whitespace character acts as separator.
count	Max number of elements in splits array.
opt	Splitting options.

Returns

Array of substrings.

Split() [9/9]

ArrayPtr< String > System::String::Split	(	const String &	separator,
		StringSplitOptions	opt = StringSplitOptions::None
	)		const

Splits string by substring.

Parameters

separator	Substring acting as separator. If empty, whitespace character acts as separator.
opt	Splitting options.

Returns

Array of substrings.

StartsWith() [1/3]

bool System::String::StartsWith

(

const String &

value

)

const

Checks if string begins with specified substring.

Parameters

value

Lookup string.

Returns

true if string starts with specified substring, false otherwise.

StartsWith() [2/3]

bool System::String::StartsWith	(	const String &	value,
		bool	ignoreCase,
		const SharedPtr< System::Globalization::CultureInfo > &	culture = nullptr
	)		const

Checks if string begins with specified substring.

Parameters

value	Lookup string.
ignoreCase	Specifies whether comparison is case-insensitive.
culture	Culture to use while performing string comparison.

Returns

true if string starts with specified substring, false otherwise.

StartsWith() [3/3]

bool System::String::StartsWith	(	const String &	value,
		System::StringComparison	comparisonType
	)		const

Checks if string begins with specified substring.

Parameters

value	Lookup string.
comparisonType	Comparison mode, see System::StringComparison for details.

Returns

true if string starts with specified substring, false otherwise.

Substring() [1/2]

String System::String::Substring

(

int32_t

startIndex

)

const

Extracts substring.

Parameters

startIndex

Substring start index.

Returns

Extracted substring.

Substring() [2/2]

String System::String::Substring	(	int32_t	startIndex,
		int32_t	length
	)		const

Extracts substring.

Parameters

startIndex	Substring start index.
length	Substring length.

Returns

Extracted substring.

ToAsciiString()

std::string System::String::ToAsciiString

(

)

const

Converts string to std::string. Uses ASCII encoding.

Returns

String representation in Ascii.

Exceptions

FormatException

if a string contains non-ASCII characters.

ToByteArray()

ArrayPtr< uint8_t > System::String::ToByteArray	(	int32_t	startIndex = 0,
		int32_t	length = INT32_MAX,
		bool	LE = true
	)		const

Converts string or substring to array of bytes.

Parameters

startIndex	Substring start index.
length	Substring length.
LE	If true, encode characters using little endianness; otherwise, use big endianness.

Returns

Array containing bytes representing characters of the string.

ToCharArray()

ArrayPtr< char_t > System::String::ToCharArray	(	int32_t	startIndex = 0,
		int32_t	length = INT32_MAX
	)		const

Converts string or substring to array of characters.

Parameters

startIndex	Substring start index.
length	Substring length.

Returns

Array containing characters of the string.

ToLower() [1/2]

String System::String::ToLower

(

)

const

Converts all string's characters to lower case.

Returns

Converted string.

ToLower() [2/2]

String System::String::ToLower

(

const SharedPtr< System::Globalization::CultureInfo > &

cultureInfo

)

const

Converts all string's characters to lower case using specific culture.

Parameters

cultureInfo

Culture to use.

Returns

Converted string.

ToLowerInvariant()

String System::String::ToLowerInvariant

(

)

const

Converts all string's characters to lower case using invariant culture.

Returns

Converted string.

ToString() [1/2]

String System::String::ToString ( ) const

inline

Wrapper for handling String class in contexts where ToString() is being called on value type objects.

Returns

Copy of current string. It is considered a null string if current string is a null string.

ToString() [2/2]

String System::String::ToString ( const SharedPtr< IFormatProvider > &  ) const

inline

Wrapper for handling String class in contexts where ToString() is being called on value type objects.

Returns

Copy of current string. It is considered a null string if current string is a null string.

ToU16Str()

std::u16string System::String::ToU16Str

(

)

const

Converts string to std::u16string.

Returns

Original string converted to u16string.

ToU32Str()

std::u32string System::String::ToU32Str

(

)

const

Converts string to std::u32string.

Returns

Original string converted to u32string.

ToUpper() [1/2]

String System::String::ToUpper

(

)

const

Converts all string's characters to upper case.

Returns

Converted string.

ToUpper() [2/2]

String System::String::ToUpper

(

const SharedPtr< System::Globalization::CultureInfo > &

cultureInfo

)

const

Converts all string's characters to upper case using specific culture.

Parameters

cultureInfo

Culture to use.

Returns

Converted string.

ToUpperInvariant()

String System::String::ToUpperInvariant

(

)

const

Converts all string's characters to upper case using invariant culture.

Returns

Converted string.

ToUtf8String()

std::string System::String::ToUtf8String

(

)

const

Converts string to std::string. Uses UTF-8 encoding.

Returns

String representation in utf-8.

ToWCS()

std::wstring System::String::ToWCS

(

)

const

Converts string to std::wstring.

Returns

Original string converted to wstring.

Trim() [1/4]

String System::String::Trim

(

)

const

Removes all whitespace characters from both beginning and end of the string.

Returns

String with no whitespaces at beginning or end.

Trim() [2/4]

String System::String::Trim

(

char_t

ch

)

const

Removes all occurrences of passed character from both beginning and end of the string.

Parameters

ch	Symbol to remove.

Returns

Removal result.

Trim() [3/4]

String System::String::Trim

(

const ArrayPtr< char_t > &

anyOf

)

const

Removes all occurrences of passed characters from both beginning and end of the string.

Parameters

anyOf

Array of characters to remove.

Returns

String without removed characters.

Trim() [4/4]

String System::String::Trim

(

const String &

anyOf

)

const

Removes all occurrences of passed characters from both beginning and end of the string.

Parameters

anyOf

String of characters to remove.

Returns

String without removed characters.

TrimEnd() [1/4]

String System::String::TrimEnd

(

)

const

Removes all whitespace characters from end of the string.

Returns

String with no whitespaces at beginning.

TrimEnd() [2/4]

String System::String::TrimEnd

(

char_t

ch

)

const

Removes all occurrences of passed character from end of the string.

Parameters

ch	Symbol to remove.

Returns

Removal result.

TrimEnd() [3/4]

String System::String::TrimEnd

(

const ArrayPtr< char_t > &

anyOf

)

const

Removes all occurrences of passed characters from end of the string.

Parameters

anyOf

Array of characters to remove.

Returns

String without removed characters.

TrimEnd() [4/4]

String System::String::TrimEnd

(

const String &

anyOf

)

const

Removes all occurrences of passed characters from end of the string.

Parameters

anyOf

String of characters to remove.

Returns

String without removed characters.

TrimStart() [1/4]

String System::String::TrimStart

(

)

const

Removes all whitespace characters from beginning of the string.

Returns

String with no whitespaces at beginning.

TrimStart() [2/4]

String System::String::TrimStart

(

char_t

ch

)

const

Removes all occurrences of passed character from beginning of the string.

Parameters

ch	Symbol to remove.

Returns

Removal result.

TrimStart() [3/4]

String System::String::TrimStart

(

const ArrayPtr< char_t > &

anyOf

)

const

Removes all occurrences of passed characters from beginning of the string.

Parameters

anyOf

Array of characters to remove.

Returns

String without removed characters.

TrimStart() [4/4]

String System::String::TrimStart

(

const String &

anyOf

)

const

Removes all occurrences of passed characters from beginning of the string.

Parameters

anyOf

String of characters to remove.

Returns

String without removed characters.

u_str()

const UChar * System::String::u_str

(

)

const

Returns ICU-styled null-terminated buffer. May reallocate the string.

Returns

Pointer to null-terminated string buffer.

Member Data Documentation

Empty

const String System::String::Empty

static

Empty string.

m_state

uintptr_t System::String::m_state

protected

String state. Contains value 0 if string is null, 1 if string is constructed from string literal.

m_str

Detail::UnicodeStringHolder System::String::m_str

mutableprotected

Actual string value.

Null

const String System::String::Null

static

Null string.