Movatterモバイル変換

Constant to be used in the UnicodeString(char *, int32_t, EInvariant) constructor which constructs a Unicode string from an invariant-character char * string.

Use the macro US_INV instead of the full qualification for this value.

See also

US_INV

Stable:

ICU 3.2

Definition at line307 of fileunistr.h.

Construct an emptyUnicodeString.

Stable:

ICU 2.0

Definition at line4182 of fileunistr.h.

Construct aUnicodeString with capacity to holdcapacity char16_ts.

Parameters

capacity	the number of char16_ts thisUnicodeString should hold before a resize is necessary; if count is greater than 0 and count code points c take up more space than capacity, then capacity is adjusted accordingly.
c	is used to initially fill the string
count	specifies how many code points c are to be written in the string

Stable:

ICU 2.0

Single char16_t (code unit) constructor.

It is recommended to mark this constructor "explicit" by-DUNISTR_FROM_CHAR_EXPLICIT=explicit on the compiler command line or similar.

Parameters

ch	the character to place in theUnicodeString

Stable:

ICU 2.0

Single UChar32 (code point) constructor.

It is recommended to mark this constructor "explicit" by-DUNISTR_FROM_CHAR_EXPLICIT=explicit on the compiler command line or similar.

Parameters

ch	the character to place in theUnicodeString

Stable:

ICU 2.0

nullptr_t constructor.

Effectively the same as the default constructor, makes an empty string object.

It is recommended to mark this constructor "explicit" by-DUNISTR_FROM_STRING_EXPLICIT=explicit on the compiler command line or similar.

Parameters

text

nullptr

Stable:

ICU 59

Definition at line4186 of fileunistr.h.

char16_t* constructor.

Note, for string literals: Since C++17 and ICU 76, you can use UTF-16 string literals with compile-time length determination:

Parameters

text	The characters to place in theUnicodeString.
textLength	The number of Unicode characters intext to copy.

Stable:

ICU 2.0

uint16_t * constructor.

Delegates toUnicodeString(const char16_t *, int32_t).

Note, for string literals: Since C++17 and ICU 76, you can use UTF-16 string literals with compile-time length determination:

Parameters

text	UTF-16 string
textLength	string length

Stable:

ICU 59

Definition at line3225 of fileunistr.h.

wchar_t * constructor.

(Only defined if U_SIZEOF_WCHAR_T==2.) Delegates toUnicodeString(const char16_t *, int32_t).

Note, for string literals: Since C++17 and ICU 76, you can use UTF-16 string literals with compile-time length determination:

Parameters

text	UTF-16 string
textLength	string length

Stable:

ICU 59

Definition at line3247 of fileunistr.h.

nullptr_t constructor.

Effectively the same as the default constructor, makes an empty string object.

Parameters

text	nullptr
textLength	ignored

Stable:

ICU 59

Definition at line4190 of fileunistr.h.

Constructor fromtext which is, or which is implicitly convertible to, a std::u16string_view or (if U_SIZEOF_WCHAR_T==2) std::wstring_view.

The string is bogus if the string view is too long.

If you need aUnicodeString but need not copy the string view contents, then you can call theUnicodeString::readOnlyAlias() function instead of this constructor.

Parameters

text	UTF-16 string

Draft:

This API may be changed in the future versions and was introduced in ICU 76

Definition at line3274 of fileunistr.h.

Readonly-aliasing char16_t* constructor.

The text will be used for theUnicodeString object, but it will not be released when theUnicodeString is destroyed. This has copy-on-write semantics: When the string is modified, then the buffer is first copied into newly allocated memory. The aliased buffer is never modified.

In an assignment to anotherUnicodeString, when using the copy constructor or the assignment operator, the text will be copied. When usingfastCopyFrom(), the text will be aliased again, so that both strings then alias the same readonly-text.

Note, for string literals: Since C++17 and ICU 76, you can use UTF-16 string literals with compile-time length determination:

Parameters

isTerminated	specifies iftext isNUL-terminated. This must be true iftextLength==-1.
text	The characters to alias for theUnicodeString.
textLength	The number of Unicode characters intext to alias. If -1, then this constructor will determine the length by callingu_strlen().

Stable:

ICU 2.0

Writable-aliasing char16_t* constructor.

The text will be used for theUnicodeString object, but it will not be released when theUnicodeString is destroyed. This has write-through semantics: For as long as the capacity of the buffer is sufficient, write operations will directly affect the buffer. When more capacity is necessary, then a new buffer will be allocated and the contents copied as with regularly constructed strings. In an assignment to anotherUnicodeString, the buffer will be copied. The extract(Char16Ptr dst) function detects whether the dst pointer is the same as the string buffer itself and will in this case not copy the contents.

Parameters

buffer	The characters to alias for theUnicodeString.
buffLength	The number of Unicode characters inbuffer to alias.
buffCapacity	The size ofbuffer in char16_ts.

Stable:

ICU 2.0

Writable-aliasing uint16_t * constructor.

Delegates to UnicodeString(const char16_t *, int32_t, int32_t).

Parameters

buffer	writable buffer of/for UTF-16 text
buffLength	length of the current buffer contents
buffCapacity	buffer capacity

Stable:

ICU 59

Definition at line3343 of fileunistr.h.

Writable-aliasing wchar_t * constructor.

(Only defined if U_SIZEOF_WCHAR_T==2.) Delegates to UnicodeString(const char16_t *, int32_t, int32_t).

Parameters

buffer	writable buffer of/for UTF-16 text
buffLength	length of the current buffer contents
buffCapacity	buffer capacity

Stable:

ICU 59

Definition at line3357 of fileunistr.h.

Writable-aliasing nullptr_t constructor.

Effectively the same as the default constructor, makes an empty string object.

Parameters

buffer	nullptr
buffLength	ignored
buffCapacity	ignored

Stable:

ICU 59

Definition at line4194 of fileunistr.h.

char* constructor.

Uses the default converter (and thus depends on the ICU conversion code) unless U_CHARSET_IS_UTF8 is set to 1.

For ASCII (really "invariant character") strings it is more efficient to use the constructor that takes a US_INV (for its enum EInvariant).

Note, for string literals: Since C++17 and ICU 76, you can use UTF-16 string literals with compile-time length determination:

It is recommended to mark this constructor "explicit" by-DUNISTR_FROM_STRING_EXPLICIT=explicit on the compiler command line or similar.

Parameters

codepageData

an array of bytes, null-terminated, in the platform's default codepage.

Stable:

ICU 2.0

char* constructor.

Uses the default converter (and thus depends on the ICU conversion code) unless U_CHARSET_IS_UTF8 is set to 1.

Parameters

codepageData	an array of bytes in the platform's default codepage.
dataLength	The number of bytes incodepageData.

Stable:

ICU 2.0

char* constructor.

Parameters

codepageData	an array of bytes, null-terminated
codepage	the encoding ofcodepageData. The special value 0 forcodepage indicates that the text is in the platform's default codepage.

Ifcodepage is an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. Seeutypes.h. Recommendation: For invariant-character strings use the constructorUnicodeString(const char *src, int32_t length, enum EInvariant inv) because it avoids object code dependencies ofUnicodeString on the conversion code.

Stable:

ICU 2.0

char* constructor.

Parameters

codepageData	an array of bytes.
dataLength	The number of bytes incodepageData.
codepage	the encoding ofcodepageData. The special value 0 forcodepage indicates that the text is in the platform's default codepage. Ifcodepage is an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. Seeutypes.h. Recommendation: For invariant-character strings use the constructorUnicodeString(const char *src, int32_t length, enum EInvariant inv) because it avoids object code dependencies ofUnicodeString on the conversion code.

Stable:

ICU 2.0

char * / UConverter constructor.

This constructor uses an existing UConverter object to convert the codepage string to Unicode and construct aUnicodeString from that.

The converter is reset at first. If the error code indicates a failure before this constructor is called, or if an error occurs during conversion or construction, then the string will be bogus.

This function avoids the overhead of opening and closing a converter if multiple strings are constructed.

Parameters

src	input codepage string
srcLength	length of the input string, can be -1 for NUL-terminated strings
cnv	converter object (ucnv_resetToUnicode() will be called), can be nullptr for the default converter
errorCode	normal ICU error code

Stable:

ICU 2.0

Constructs a Unicode string from an invariant-character char * string.

About invariant characters seeutypes.h. This constructor has no runtime dependency on conversion code and is therefore recommended over ones taking a charset name string (where the empty string "" indicates invariant-character conversion).

Use the macro US_INV as the third, signature-distinguishing parameter.

For example:

Note, for string literals: Since C++17 and ICU 76, you can use UTF-16 string literals with compile-time length determination:

Parameters

src	String using only invariant characters.
textLength	Length of src, or -1 if NUL-terminated.
inv	Signature-distinguishing parameter, use US_INV.

See also

US_INV

Stable:

ICU 3.2

Copy constructor.

Starting with ICU 2.4, the assignment operator and the copy constructor allocate a new buffer and copy the buffer contents even for readonly aliases. By contrast, thefastCopyFrom() function implements the old, more efficient but less safe behavior of making this string also a readonly alias to the same buffer.

If the source object has an "open" buffer from getBuffer(minCapacity), then the copy is an empty string.

Parameters

that	TheUnicodeString object to copy.

Stable:

ICU 2.0

See also

fastCopyFrom

Move constructor; might leave src in bogus state.

This string will have the same contents and state that the source string had.

Parameters

src	source string

Stable:

ICU 56

'Substring' constructor from tail of source string.

Parameters

src	TheUnicodeString object to copy.
srcStart	The offset intosrc at which to start copying.

Stable:

ICU 2.2

'Substring' constructor from subrange of source string.

Parameters

src	TheUnicodeString object to copy.
srcStart	The offset intosrc at which to start copying.
srcLength	The number of characters fromsrc to copy.

Stable:

ICU 2.2

Destructor.

Stable:

ICU 2.0

Append the code unitsrcChar to theUnicodeString object.

Parameters

srcChar

the code unit to append

Returns

a reference to this

Stable:

ICU 2.0

Definition at line4981 of fileunistr.h.

Append the characters insrcChars in the range [srcStart,srcStart + srcLength) to theUnicodeString object at offsetstart.

srcChars is not modified.

Parameters

srcChars	the source for the new characters
srcStart	the offset intosrcChars where new characters will be obtained
srcLength	the number of characters insrcChars in the append string; can be -1 ifsrcChars is NUL-terminated

Returns

a reference to this

Stable:

ICU 2.0

Definition at line4970 of fileunistr.h.

Appends the characters insrc which is, or which is implicitly convertible to, a std::u16string_view or (if U_SIZEOF_WCHAR_T==2) std::wstring_view, to theUnicodeString object.

Parameters

src	the source for the new characters

Returns

a reference to this

Draft:

This API may be changed in the future versions and was introduced in ICU 76

Definition at line2300 of fileunistr.h.

Append the characters insrcText to theUnicodeString object.

srcText is not modified.

Parameters

srcText

the source for the new characters

Returns

a reference to this

Stable:

ICU 2.0

Definition at line4966 of fileunistr.h.

Referenceslength().

Append the characters insrcText in the range [srcStart,srcStart + srcLength) to theUnicodeString object at offsetstart.

srcText is not modified.

Parameters

srcText	the source for the new characters
srcStart	the offset intosrcText where new characters will be obtained
srcLength	the number of characters insrcText in the append string

Returns

a reference to this

Stable:

ICU 2.0

Definition at line4960 of fileunistr.h.

Referenced byicu::Transliterator::setID().

Append the characters insrcChars to theUnicodeString object.

srcChars is not modified.

Parameters

srcChars	the source for the new characters
srcLength	the number of Unicode characters insrcChars; can be -1 ifsrcChars is NUL-terminated

Returns

a reference to this

Stable:

ICU 2.0

Definition at line4976 of fileunistr.h.

Append the code pointsrcChar to theUnicodeString object.

Parameters

srcChar

the code point to append

Returns

a reference to this

Stable:

ICU 2.0

Compare two strings case-insensitively using full case folding.

This is equivalent to this->foldCase(options).compare(text.foldCase(options)).

Parameters

text	Another string to compare this one to.
options	A bit set of options: U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding. U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details). U_FOLD_CASE_EXCLUDE_SPECIAL_I

Returns

A negative, zero, or positive integer indicating the comparison result.

Stable:

ICU 2.0

Definition at line4443 of fileunistr.h.

Referenceslength().

Compare two strings case-insensitively using full case folding.

This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).

Parameters

srcChars	A pointer to another string to compare this one to.
srcLength	The number of code units from that string to compare.
options	A bit set of options: U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding. U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details). U_FOLD_CASE_EXCLUDE_SPECIAL_I

Returns

A negative, zero, or positive integer indicating the comparison result.

Stable:

ICU 2.0

Definition at line4456 of fileunistr.h.

Compare two strings case-insensitively using full case folding.

This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).

Parameters

start	The start offset in this string at which the compare operation begins.
length	The number of code units from this string to compare.
srcChars	A pointer to another string to compare this one to.
srcStart	The start offset in that string at which the compare operation begins.
srcLength	The number of code units from that string to compare.
options	A bit set of options: U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding. U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details). U_FOLD_CASE_EXCLUDE_SPECIAL_I

Returns

A negative, zero, or positive integer indicating the comparison result.

Stable:

ICU 2.0

Definition at line4481 of fileunistr.h.

Compare two strings case-insensitively using full case folding.

This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).

Parameters

start	The start offset in this string at which the compare operation begins.
length	The number of code units from this string to compare.
srcChars	A pointer to another string to compare this one to.
options	A bit set of options: U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding. U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details). U_FOLD_CASE_EXCLUDE_SPECIAL_I

Returns

A negative, zero, or positive integer indicating the comparison result.

Stable:

ICU 2.0

Definition at line4473 of fileunistr.h.

Compare two strings case-insensitively using full case folding.

This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).

Parameters

start	The start offset in this string at which the compare operation begins.
length	The number of code units from this string to compare.
srcText	Another string to compare this one to.
srcStart	The start offset in that string at which the compare operation begins.
srcLength	The number of code units from that string to compare.
options	A bit set of options: U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding. U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details). U_FOLD_CASE_EXCLUDE_SPECIAL_I

Returns

A negative, zero, or positive integer indicating the comparison result.

Stable:

ICU 2.0

Definition at line4463 of fileunistr.h.

Compare two strings case-insensitively using full case folding.

This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).

Parameters

start	The start offset in this string at which the compare operation begins.
length	The number of code units from this string to compare.
srcText	Another string to compare this one to.
options	A bit set of options: U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding. U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details). U_FOLD_CASE_EXCLUDE_SPECIAL_I

Returns

A negative, zero, or positive integer indicating the comparison result.

Stable:

ICU 2.0

Definition at line4448 of fileunistr.h.

Referenceslength().

Compare two strings case-insensitively using full case folding.

This is equivalent to this->foldCase(options).compareBetween(text.foldCase(options)).

Parameters

start	The start offset in this string at which the compare operation begins.
limit	The offset after the last code unit from this string to compare.
srcText	Another string to compare this one to.
srcStart	The start offset in that string at which the compare operation begins.
srcLimit	The offset after the last code unit from that string to compare.
options	A bit set of options: U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding. U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details). U_FOLD_CASE_EXCLUDE_SPECIAL_I

Returns

A negative, zero, or positive integer indicating the comparison result.

Stable:

ICU 2.0

Definition at line4491 of fileunistr.h.

Return the code point that contains the code unit at offsetoffset.

If the offset is not valid (0..length()-1) then U+ffff is returned.

Parameters

offset

a valid offset into the text that indicates the text offset of any of the code units that will be assembled into a code point (21-bit value) and returned

Returns

the code point of text atoffset or 0xffff if the offset is not valid for this string

Stable:

ICU 2.0

Referenced byicu::DecimalFormatSymbols::setSymbol().

Return the code unit at offsetoffset.

If the offset is not valid (0..length()-1) then U+ffff is returned.

Parameters

offset

a valid offset into the text

Returns

the code unit at offsetoffset or 0xffff if the offset is not valid for this string

Stable:

ICU 2.0

Definition at line4855 of fileunistr.h.

Clone this object, an instance of a subclass ofReplaceable.

Clones can be used concurrently in multiple threads. If a subclass does not implementclone(), or if an error occurs, then nullptr is returned. The caller must delete the clone.

Returns

a clone of this object

See also

Replaceable::clone

getDynamicClassID

Stable:

ICU 2.6

Reimplemented fromicu::Replaceable.

Compare the characters bitwise in thisUnicodeString to the characters intext.

Parameters

text	TheUnicodeString to compare to this one.

Returns

The result of bitwise character comparison: 0 if this contains the same characters astext, -1 if the characters in this are bitwise less than the characters intext, +1 if the characters in this are bitwise greater than the characters intext.

Stable:

ICU 2.0

Definition at line4320 of fileunistr.h.

Referenceslength().

Compare the characters bitwise in thisUnicodeString with the firstsrcLength characters insrcChars.

Parameters

srcChars	The characters to compare to thisUnicodeString.
srcLength	the number of characters insrcChars to compare

Returns

The result of bitwise character comparison: 0 if this contains the same characters assrcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars.

Stable:

ICU 2.0

Definition at line4330 of fileunistr.h.

Compare the characters bitwise in the range [start,start + length) with the firstlength characters insrcChars

Parameters

start	the offset at which the compare operation begins
length	the number of characters to compare.
srcChars	the characters to be compared

Returns

The result of bitwise character comparison: 0 if this contains the same characters assrcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars.

Stable:

ICU 2.0

Definition at line4343 of fileunistr.h.

Compare the characters bitwise in the range [start,start + length) with the characters insrcChars in the range [srcStart,srcStart + srcLength).

Parameters

start	the offset at which the compare operation begins
length	the number of characters in this to compare
srcChars	the characters to be compared
srcStart	the offset intosrcChars to start comparison
srcLength	the number of characters insrcChars to compare

Returns

The result of bitwise character comparison: 0 if this contains the same characters assrcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars.

Stable:

ICU 2.0

Definition at line4349 of fileunistr.h.

Compare the characters bitwise in the range [start,start + length) with the characters insrcText in the range [srcStart,srcStart + srcLength).

Parameters

start	the offset at which the compare operation begins
length	the number of characters in this to compare.
srcText	the text to be compared
srcStart	the offset intosrcText to start comparison
srcLength	the number of characters insrc to compare

Returns

The result of bitwise character comparison: 0 if this contains the same characters assrcText, -1 if the characters in this are bitwise less than the characters insrcText, +1 if the characters in this are bitwise greater than the characters insrcText.

Stable:

ICU 2.0

Definition at line4335 of fileunistr.h.

Compare the characters bitwise in the range [start,start + length) with the characters in theentire stringtext.

(The parameters "start" and "length" are not applied to the other text "text".)

Parameters

start	the offset at which the compare operation begins
length	the number of characters of text to compare.
text	the other text to be compared against this string.

Returns

The result of bitwise character comparison: 0 if this contains the same characters astext, -1 if the characters in this are bitwise less than the characters intext, +1 if the characters in this are bitwise greater than the characters intext.

Stable:

ICU 2.0

Definition at line4324 of fileunistr.h.

Referenceslength().

Compare the characters bitwise in the range [start,limit) with the characters insrcText in the range [srcStart,srcLimit).

Parameters

start	the offset at which the compare operation begins
limit	the offset immediately following the compare operation
srcText	the text to be compared
srcStart	the offset intosrcText to start comparison
srcLimit	the offset intosrcText to limit comparison

Returns

The result of bitwise character comparison: 0 if this contains the same characters assrcText, -1 if the characters in this are bitwise less than the characters insrcText, +1 if the characters in this are bitwise greater than the characters insrcText.

Stable:

ICU 2.0

Definition at line4357 of fileunistr.h.

Compare two Unicode strings in code point order.

The result may be different from the results ofcompare(), operator<, etc. if supplementary characters are present:

In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.

Parameters

text	Another string to compare this one to.

Returns

a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

Stable:

ICU 2.0

Definition at line4381 of fileunistr.h.

Referenceslength().

Compare two Unicode strings in code point order.

The result may be different from the results ofcompare(), operator<, etc. if supplementary characters are present:

In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.

Parameters

srcChars	A pointer to another string to compare this one to.
srcLength	The number of code units from that string to compare.

Returns

a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

Stable:

ICU 2.0

Definition at line4391 of fileunistr.h.

Compare two Unicode strings in code point order.

The result may be different from the results ofcompare(), operator<, etc. if supplementary characters are present:

In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.

Parameters

start	The start offset in this string at which the compare operation begins.
length	The number of code units from this string to compare.
srcChars	A pointer to another string to compare this one to.

Returns

a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

Stable:

ICU 2.0

Definition at line4404 of fileunistr.h.

Compare two Unicode strings in code point order.

The result may be different from the results ofcompare(), operator<, etc. if supplementary characters are present:

In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.

Parameters

start	The start offset in this string at which the compare operation begins.
length	The number of code units from this string to compare.
srcChars	A pointer to another string to compare this one to.
srcStart	The start offset in that string at which the compare operation begins.
srcLength	The number of code units from that string to compare.

Returns

a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

Stable:

ICU 2.0

Definition at line4410 of fileunistr.h.

Compare two Unicode strings in code point order.

The result may be different from the results ofcompare(), operator<, etc. if supplementary characters are present:

In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.

Parameters

start	The start offset in this string at which the compare operation begins.
length	The number of code units from this string to compare.
srcText	Another string to compare this one to.

Returns

a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

Stable:

ICU 2.0

Definition at line4385 of fileunistr.h.

Referenceslength().

Compare two Unicode strings in code point order.

The result may be different from the results ofcompare(), operator<, etc. if supplementary characters are present:

In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.

Parameters

start	The start offset in this string at which the compare operation begins.
length	The number of code units from this string to compare.
srcText	Another string to compare this one to.
srcStart	The start offset in that string at which the compare operation begins.
srcLength	The number of code units from that string to compare.

Returns

a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

Stable:

ICU 2.0

Definition at line4396 of fileunistr.h.

Compare two Unicode strings in code point order.

The result may be different from the results ofcompare(), operator<, etc. if supplementary characters are present:

In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.

Parameters

start	The start offset in this string at which the compare operation begins.
limit	The offset after the last code unit from this string to compare.
srcText	Another string to compare this one to.
srcStart	The start offset in that string at which the compare operation begins.
srcLimit	The offset after the last code unit from that string to compare.

Returns

a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

Stable:

ICU 2.0

Definition at line4418 of fileunistr.h.

Copy a substring of this object, retaining attribute (out-of-band) information.

This method is used to duplicate or reorder substrings. The destination index must not overlap the source range.

Parameters

start	the beginning index, inclusive;0 <= start <= limit.
limit	the ending index, exclusive;start <= limit <=length().
dest	the destination index. The characters fromstart..limit-1 will be copied todest. Implementations of this method may assume thatdest <= start || dest >= limit.

Stable:

ICU 2.0

Implementsicu::Replaceable.

Count Unicode code points in the length char16_t code units of the string.

A code point may occupy either one or two char16_t code units. Counting code points involves reading all code units.

This functions is basically the inverse ofmoveIndex32().

Parameters

start	the index of the first code unit to check
length	the number of char16_t code units to check

Returns

the number of code points in the specified code units

See also

length

Stable:

ICU 2.0

Referenced byicu::DecimalFormatSymbols::setSymbol().

Determine if this ends with the characters insrcChars in the range [srcStart,srcStart + srcLength).

Parameters

srcChars	The characters to match.
srcStart	the offset intosrcText to start matching
srcLength	the number of characters insrcChars to match

Returns

true if this ends with the characters insrcChars, false otherwise

Stable:

ICU 2.0

Definition at line4716 of fileunistr.h.

Referencesu_strlen().

Determine if this ends with the characters insrcText in the range [srcStart,srcStart + srcLength).

Parameters

srcText	The text to match.
srcStart	the offset intosrcText to start matching
srcLength	the number of characters insrcText to match

Returns

true if this ends with the characters intext, false otherwise

Stable:

ICU 2.0

Definition at line4698 of fileunistr.h.

Determine if this ends with the characters intext

Parameters

text	The text to match.

Returns

true if this ends with the characters intext, false otherwise

Stable:

ICU 2.0

Definition at line4693 of fileunistr.h.

Referenceslength().

Determine if this ends with the characters insrcChars

Parameters

srcChars	The characters to match.
srcLength	the number of characters insrcChars

Returns

true if this ends with the characters insrcChars, false otherwise

Stable:

ICU 2.0

Definition at line4707 of fileunistr.h.

Referencesu_strlen().

Convert theUnicodeString into a codepage string using an existing UConverter.

The output string is NUL-terminated if possible.

This function avoids the overhead of opening and closing a converter if multiple strings are extracted.

Parameters

dest	destination string buffer, can be nullptr if destCapacity==0
destCapacity	the number of chars available at dest
cnv	the converter object to be used (ucnv_resetFromUnicode() will be called), or nullptr for the default converter
errorCode	normal ICU error code

Returns

the length of the output string, not counting the terminating NUL; if the length is greater than destCapacity, then the string will not fit and a buffer of the indicated length would need to be passed in

Stable:

ICU 2.0

Copy the contents of the string into dest.

This is a convenience function that checks if there is enough space in dest, extracts the entire string if possible, and NUL-terminates dest if possible.

If the string fits into dest but cannot be NUL-terminated (length()==destCapacity) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the string itself does not fit into dest (length()>destCapacity) then the error code is set to U_BUFFER_OVERFLOW_ERROR.

If the string aliases todest itself as an external buffer, thenextract() will not copy the contents.

Parameters

dest	Destination string buffer.
destCapacity	Number of char16_ts available at dest.
errorCode	ICU error code.

Returns

length()

Stable:

ICU 2.0

Copy the characters in the range [start,start + length) into the arraydst, beginning atdstStart.

If the string aliases todst itself as an external buffer, thenextract() will not copy the contents.

Parameters

start	offset of first character which will be copied into the array
length	the number of characters to extract
dst	array in which to copy characters. The length ofdst must be at least (dstStart + length).
dstStart	the offset indst where the first character will be extracted

Stable:

ICU 2.0

Definition at line4802 of fileunistr.h.

Copy the characters in the range [start,start + length) into theUnicodeStringtarget.

Parameters

start	offset of first character which will be copied
length	the number of characters to extract
target	UnicodeString into which to copy characters.

Stable:

ICU 2.0

Definition at line4809 of fileunistr.h.

Copy the characters in the range [start,start + length) into an array of characters in a specified codepage.

The output string is NUL-terminated.

Recommendation: For invariant-character strings useextract(int32_t start, int32_t length, char *target, int32_t targetCapacity, enum EInvariant inv) const because it avoids object code dependencies ofUnicodeString on the conversion code.

Parameters

start	offset of first character which will be copied
startLength	the number of characters to extract
target	the target buffer for extraction
codepage	the desired codepage for the characters. 0 has the special meaning of the default codepage Ifcodepage is an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. Seeutypes.h. Iftarget is nullptr, then the number of bytes required fortarget is returned. It is assumed that the target is big enough to fit all of the characters.

Returns

the output string length, not including the terminating NUL

Stable:

ICU 2.0

Definition at line4817 of fileunistr.h.

Copy the characters in the range [start,start + startLength) into an array of characters.

All characters must be invariant (seeutypes.h). Use US_INV as the last, signature-distinguishing parameter.

This function does not write any more thantargetCapacity characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.

Parameters

start	offset of first character which will be copied
startLength	the number of characters to extract
target	the target buffer for extraction, can be nullptr if targetLength is 0
targetCapacity	the length of the target buffer
inv	Signature-distinguishing parameter, use US_INV.

Returns

the output string length, not including the terminating NUL

Stable:

ICU 3.2

Copy the characters in the range [start,start + length) into an array of characters in the platform's default codepage.

This function does not write any more thantargetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.

Parameters

start	offset of first character which will be copied
startLength	the number of characters to extract
target	the target buffer for extraction
targetLength	the length of the target buffer Iftarget is nullptr, then the number of bytes required fortarget is returned.

Returns

the output string length, not including the terminating NUL

Stable:

ICU 2.0

Copy the characters in the range [start,start + length) into an array of characters in a specified codepage.

This function does not write any more thantargetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.

Recommendation: For invariant-character strings useextract(int32_t start, int32_t length, char *target, int32_t targetCapacity, enum EInvariant inv) const because it avoids object code dependencies ofUnicodeString on the conversion code.

Parameters

start	offset of first character which will be copied
startLength	the number of characters to extract
target	the target buffer for extraction
targetLength	the length of the target buffer
codepage	the desired codepage for the characters. 0 has the special meaning of the default codepage Ifcodepage is an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. Seeutypes.h. Iftarget is nullptr, then the number of bytes required fortarget is returned.

Returns

the output string length, not including the terminating NUL

Stable:

ICU 2.0

Copy the characters in the range [start,limit) into the arraydst, beginning atdstStart.

Parameters

start	offset of first character which will be copied into the array
limit	offset immediately following the last character to be copied
dst	array in which to copy characters. The length ofdst must be at least (dstStart + (limit - start)).
dstStart	the offset indst where the first character will be extracted

Stable:

ICU 2.0

Definition at line4830 of fileunistr.h.

Copy the characters in the range [start,limit) into theUnicodeStringtarget.

Replaceable API.

Parameters

start	offset of first character which will be copied
limit	offset immediately following the last character to be copied
target	UnicodeString into which to copy characters.

Stable:

ICU 2.0

Implementsicu::Replaceable.

Almost the same as the assignment operator.

Replace the characters in thisUnicodeString with the characters fromsrcText.

This function works the same as the assignment operator for all strings except for ones that are readonly aliases.

Starting with ICU 2.4, the assignment operator and the copy constructor allocate a new buffer and copy the buffer contents even for readonly aliases. This function implements the old, more efficient but less safe behavior of making this string also a readonly alias to the same buffer.

The fastCopyFrom function must be used only if it is known that the lifetime of thisUnicodeString does not exceed the lifetime of the aliased buffer including its contents, for example for strings from resource bundles or aliases to string constants.

If the source object has an "open" buffer from getBuffer(minCapacity), then the copy is an empty string.

Parameters

src	The text containing the characters to replace.

Returns

a reference to this

Stable:

ICU 2.4

Replace all occurrences of characters in oldText with the characters in newText.

Parameters

oldText	the text containing the search text
newText	the text containing the replacement text

Returns

a reference to this

Stable:

ICU 2.0

Definition at line4779 of fileunistr.h.

Referenceslength().