Collaboration diagram

Description

SFXAnsiString and SFXWideString

In the BREW environment, there are two kinds of character types: one is the char type that represents the single/multi byte character(or the ANSI character) and the other is the AECHAR type that represents the double byte character of the uint16 type.

In SophiaFramewok UNIVERSE, these two kinds of character types are defined as AChar and WChar using typedef respectively. And two kinds of the following string classes are available:

All the functions of these two string classes are the same except their string types.

How to Empty a String

There are two methods to empty a string:

In the former method, its heap is not released. By block allocation support, to allocate new memory is unnecessary when a string is newly created in this heap. Therefore its processing speed is very fast.

In the latter method, its heap is released. Though the released heap is free for other tasks, its processing speed slows down.

Which method to choose depends upon the trade-off between processing speed and memory usage.

SFXWideString str = "The best C++ Programming Environment for BREW";

str = ";
// OR:
str.SetLength(0);

// the heap is not released

SFXWideString str = "The best C++ Programming Environment for BREW";

str.Clear();

// the heap is released

When short strings are frequently processed, the method of calling the SFXWideString::SetLength function is more efficient.

SFXWideString str;

str = "BREW";
...
str.SetLength(0);
...
str = "C++";
...
str.SetLength(0);
...
str = "GUI";
...
str.SetLength(0);
...
str = "XML";
...

Attach Function and Detach Function

The SFXWideString::Attach function attaches the string area to the SFXWideString object. The SFXWideString::Detach function has the reverse functionality.

Though the data is copied by using the SFXWideString::Set function and the substitution operator(=), while using the SFXWideString::Attach function and the SFXWideString::Detach function, data will not be copied.

When there is not enough heap for copying a several hundreds KB string, or to avoid the performance deterioration, use these functions.

Reference

SFXWideString | SFXBuffer | Character Type

Member

Description

If a string, character or buffer is specified in the argument, this constructer will set this string to the specified values by calling the SFXWideString::Set function internally.

If the cluster argument and the threshold argument are specified, the cluster size and the mininum size of the internal buffer memory will be set to the specified values by calling the SFXWideString::SetCluster function the SFXWideString::SetThreshold function internally.

Reference

SFXWideString::Set | SFXWideString::SetCluster | SFXWideString::SetThreshold

Description

This destructor releases the internal buffer memory of this string.

Return value

Description

This function adds the specified string to the end of this string.

If the pointer to the WChar string is specified as an argument, the specified string will be regarded as the null-terminated string. Moreover, by specifying the length argument, a string including several null('\0') characters can be specified.

	Note
	The value that is less than or equals the length of the string specified in the string argument must be specified in the length argument. If a negative value is specified, the length of the null-terminated string specified in the string argument will be assumed to be set. The default value of the length argument is "-1".

	Tip
	This function influences the content of this string. If you want to keep it unmodified, use the SFXWideString::Concat function.

Reference

SFXWideString::Concat | SFXWideString::Sub | SFXWideString::Mul | SFXWideString::operator<< | operator+ | SFXWideString::operator+=

Return value

This string converted to lower case

Description

This function gets this string converted to lower case.

	Note
	This string will not be modified after this function is executed.

Reference

SFXWideString::AsUpper | SFXWideString::ToLower

Return value

Integer of the SInt32 type converted from this string

Description

This function converts this string into the integer of the SInt32 type.

The " " chraracter in the head of this string will be ignored. The "+" or "-" character can be permitted to be placed at most once before the numeric string. If omitted, the numeric string will be regarded as the positive integer.

	Tip
	If this conversion fails since characters other than " ", "+", "-", or number are included in this string, the value specified in the substitute argument will be returned.

Reference

SFXWideString::AsUInt32

Return value

Integer of the UInt32 type converted from this string

Description

This function converts this string into the integer of the UInt32 type.

The " " chraracter in the head of this string will be ignored. The "+" character can be permitted to be placed at most once before the numeric string.

	Tip
	If this conversion fails since characters other than " ", "+", or number are included in this string, the value specified in the substitute argument will be returned. For instance, in case the "-" character appears before the numeric string, this conversion will fail.

Reference

SFXWideString::AsSInt32

Return value

This string converted to upper case

Description

This function gets this string converted to upper case.

	Note
	This string will not be modified after this function is executed.

Reference

SFXWideString::AsLower | SFXWideString::ToUpper

Return value

Description

This function attaches the specified string to this string object. After this function is executed, the specified string can be handled as the SFXWideString object.

This function is more efficient than the SFXWideString::Set function, since the string is not copied and the problem on insufficient memory or performance deterioration can be avoided.

	Note
	When this string object is released, the specified string will be released automatically together with this string object.

Example

SFXWideString string;
WCharPtr char_ptr;

// allocate the 10240-byte string area to char_ptr
char_ptr = static_cast<WCharPtr>(MemoryAllocate(10240));

...

// attach the allocated char_ptr area to the string object
string.Attach(char_ptr, 10240);

// hereafter, the allocated char_ptr area can be handled as the string object

･･･

// after used, the allocated char_ptr area will be released automatically

Reference

SFXWideString::Detach

Return value

Description

	Caution
	Since this function is deprecated, use the SFXWideString::Attach function.

Reference

SFXWideString::Attach | SFXWideString::Detach | SFXWideString::DetachSFXBuffer

Description

This function clears this string.

	Note
	The memory area allocated to this string before this function is executed will be released.

Return value

Description

This function compares this string with the specified string in dictionary order.

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

Reference

SFXWideString::Equals | operator== | operator!=

Return value

String obtained by concatenating this string and the specified string.

Description

This function gets the string obtained by concatenating this string and the specified string.

If the pointer to the WChar string is specified as an argument, the specified string will be regarded as the null-terminated string. Moreover, by specifying the length argument, a string including several null('\0') characters can be specified.

	Note
	The value that is less than or equals the length of the string specified in the string argument must be specified in the length argument. If a negative value is specified, the length of the null-terminated string specified in the string argument will be assumed to be set. The default value of the length argument is "-1".

	Tip
	Different from the SFXWideString::Add function, this string will not be modified after this function is executed.

Reference

SFXWideString::Add | operator+ | SFXWideString::operator+=

Return value

Description

This function overwrites the specified substring of this string with the specified string.

If the end of the copied string exceeds that of this string or the index argument points to out of this string, SFERR_INVALID_PARAM will be return. This string will not be overwritten.

If the pointer to the WChar string is specified as an argument, the specified string will be regarded as the null-terminated string. Moreover, by specifying the length argument, a string including several null('\0') characters can be specified.

	Note
	The value that is less than or equals the length of the string specified in the string argument must be specified in the length argument. If a negative value is specified, the length of the null-terminated string specified in the string argument will be assumed to be set. The default value of the length argument is "-1".

Return value

Return the string which this string object has in case it is detached to the WChar string. Otherwise, return the SFCError object.

Description

This function is more efficient than the SFXWideString::GetChar function, since the string area is not copied and the problem on insufficient memory or performance deterioration can be avoided.

Example

SFXWideString string;
WCharPtr char_ptr;
SInt32 length;

string = "The best application for BREW.";

...

// detach the string area from this string object and set the char_ptr variable to this pointer
// the size of the detached string area will be stored into the length variable
char_ptr = string.Detach(&length);

// hereafter, the string area of the string object will be handled via the char_ptr variable

...

// after used, the detached string area must be released explicitly
MemoryFree(char_ptr);

Reference

SFXWideString::Attach

Return value

Description

	Caution
	Since this function is deprecated, use the SFXWideString::Detach function.

Reference

SFXWideString::Attach | SFXWideString::AttachSFXBuffer | SFXWideString::Detach

Return value

Empty string

Description

This function gets the empty string.

	Tip
	This function will used to return the reference to the empty string as the return value of a function.

Return value

Description

This function checks whether or not this string ends with the specified string.

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

Reference

SFXWideString::StartsWith

Return value

Description

This function checks whether or not this string equals the specified string.

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

Reference

SFXWideString::Compare | operator== | operator!=

Description

This function fills this string with the specified character.

Return value

Description

This function gets the first index of this string to match the specified value, searching from the beginning.

The index argument is used to search from other than the beginning. (The origin index is 0.)

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

Reference

SFXWideString::LastIndexOf

Description

This function creates a string from the specified data by using the specified format.

This function is almost the same as the printf function in C language, except that the floating-point format is not available.

	Note
	For more details on the format, see BREW API SPRINTF.

Example

SIntN year = 2003;
SIntN month = 8;
SFXWideString str = SFXWideString::Format("%d Year %d Month ", year, month);

Reference

BREW API SPRINTF

Description

This function creates a string from the variable-length argument by using the specified format.

This function is almost the same as the printf function in C language, except that the floating-point format is not available.

	Note
	For more details on the format, see BREW API SPRINTF.

Example

SFXWideString MyClass::variableArgument(SInt32 arg_num , ...) 
{
    va_list argument;

	va_start(argument, arg_num);
    
	SFXWideString str = SFXWideString::FormatV("%d Year %d Month %d Day %d Time %d Minute %d Second, It is %s today.", argument);
    
	va_end(argument);
   
	return str;

}

SFXWideString str = variableArgument(7, 2007, 7, 17, 17, 37, 50,"rainy");
// str = " 2007 Year 7 Month 17 Day 17 Time 37 Minute 50 Second, It is rainy today."

Reference

BREW API VSNPRINTF | BREW API SPRINTF

Return value

Pointer to the internal buffer of this string.

Description

This function gets the pointer to the internal buffer of this string, through which data can be written into the internal buffer.

If this string is empty, null will be returned.

	Caution
	You should not access the position over the length returned obtained by the SFXWideString::GetLength function from the position that the pointer to the internal buffer of this string.

Difference between the GetBuffer function and the GetCString function

When this string is empty, the SFXWideString::GetCString function will return the pointer to "\0", on the other hand, the SFXWideString::GetBuffer function will return null. Since the pointer returned by the SFXWideString::GetCString function is of the const type, no data can be written into the internal buffer through this pointer. To write data into the internal buffer, use the SFXWideString::GetBuffer function.

Reference

SFXWideString::GetCString | SFXWideString::GetLength

Return value

Pointer of the WCharConstPtr type to the internal buffer of this string

Description

This function gets the pointer of the WCharConstPtr type to the internal buffer of this string, through which data cannot be written into the internal buffer.

If this string is empty, the pointer to "\0" will be returned.

Difference between the GetBuffer function and the GetCString function

When this string is empty, the SFXWideString::GetCString function will return the pointer to "\0", on the other hand, the SFXWideString::GetBuffer function will return null. Since the pointer returned by the SFXWideString::GetCString function is of the const type, no data can be written into the internal buffer through this pointer. To write data into the internal buffer, use the SFXWideString::GetBuffer function.

Reference

SFXWideString::GetBuffer

Return value

Character at the specified index of this string. If this string is empty or the specified index is out of range of this string , null('\0') will be returned.

Description

This function gets the character at the specified index of this string.

	Caution
	If this string is empty or the specified index is out of range of this string , null('\0') will be returned.

Reference

SFXWideString::GetBuffer | SFXWideString::SetChar

Return value

Cluster size of the internal buffer memory of this string. [in bytes]

Description

This function gets cluster size of the internal buffer memory of this string. [in bytes]

Reference

SFXWideString::SetCluster

Return value

Length(number of the characters) of this string.

Description

This function gets the length(number of the characters) of this string.

	Note
	If this string includes "\0", "\0" will be counted.

Example

SFXWideString str("abc\0abc", 7);
int i;
i = str.GetLengthCString(); // i = 3
i = str.GetLength();        // i = 7

Reference

SFXWideString::GetLengthCString | SFXWideString::SetLength

Return value

Length(number of the characters) until the first "\0" character of this string.

Description

This function gets the length(number of the characters) until the first "\0" character of this string.

	Note
	The first "\0" character will not be counted.

Example

SFXWideString str("abc\0abc", 7);
int i;
i = str.GetLengthCString(); // i = 3
i = str.GetLength();        // i = 7

Reference

SFXWideString::GetLength

Return value

Minimum size of the internal buffer memory of this string. [in bytes]

Description

This function gets the minimum size of the internal buffer memory of this string. [in bytes]

Reference

SFXWideString::SetThreshold

Return value

String obtained by inserting the specified string or character at the specified index of this string.

Description

This function gets the string obtained by inserting the specified string or character at the specified index of this string.

If the index argument is less than 0, 0 will be assumed to be specified. And if the index argument is greater than or equals the length of this string, "lenght of this string" will be assumed to be specified.

	Caution
	The content of this string will not be modified by this operation.

Return value

Description

This function checks whether or not all the characters of this string are alphabetic.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsAlpha

Return value

Description

This function checks whether or not all the characters of this string are alphanumeric.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsAlphaDigit

Return value

Description

This function checks whether or not all the characters of this string are ASCII.

	ASCII character
	The code of the ASCII character is greater than or equals 0x00 and less than or equals 0x7F.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsAscii

Return value

Description

This function checks whether or not all the characters of this string are the control characters.

	Control character
	The code of the control character is less than 0x20, or equals 0x7F.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsControl

Return value

Description

This function checks whether or not all the characters of this string are digit.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsDigit

Return value

Description

This function checks whether or not the length of this string is 0(this string is empty).

Example

SFXWideString str("\0abc", 4);
Bool b;
b = str.IsEmptyCString(); // b = true
b = str.IsEmpty();        // b = false

Reference

SFXWideString::IsEmptyCString | SFXWideString::GetLength

Return value

Description

This function checks whether or not the first character of this string is null('\0').

Example

SFXWideString str("\0abc", 4);
Bool b;
b = str.IsEmptyCString(); // b = true
b = str.IsEmpty();        // b = false

Reference

SFXWideString::IsEmpty | SFXWideString::GetLength

Return value

Description

This function checks whether or not all the characters of this string are graphic.

	Graphic character
	The graphic character is a printable character except the space character( 0x20 ). The code of the graphic character is greater than 0x20 and less than 0x7E.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsGraph

Return value

Description

This function checks whether or not all the characters of this string are Hex digit(digit, or a, b, c, d, e, f, A, B, C, D, E, F).

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsHexDigit

Return value

Description

This function checks whether or not all the characters of this string are lower-case.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsLower

Return value

Description

This function checks whether or not all the characters of this string are null('\0').

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsNull

Return value

Description

This function checks whether or not all the characters of this string are printable.

	Printable character
	The printable character is the character that can be displayed. The code of the printable character is greater than or equals 0x20 and less than 0x7E.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsPrint

Return value

Description

This function checks whether or not all the characters of this string are not space nor alphanumeric but printable.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsPunct

Return value

Description

This function checks whether or not all the characters of this string are space.

	Space character
	The code of the space character including tab, line-feed, and carriage return is from 0x09 to 0x0D or 0x20.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsSpace

Return value

Description

This function checks whether or not all the characters of this string are upper-case.

	Caution
	If this string is empty, true will be returned.

Reference

SFXAscii::IsUpper

Return value

Description

This function gets the last index of this string to match the specified value, searching from the end.

The index argument is used to search from other than the end. (The origin index is 0.)

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

Reference

SFXWideString::FirstIndexOf

Return value

Description

This function makes this string repeated by the specified times.

This string will be updated after this function is executed. To presereve this string, copy it somewhere beforehand.

Example

SFXWideString str("abc");
str.Mul(3); // str = "abcabcabc"

Reference

SFXWideString::Add | SFXWideString::Sub | operator* | SFXWideString::operator*=

Return value

String obtained by removing characters in the specified range from this string.

Description

This function gets the string obtained by removing characters in the specified range from this string.

If the begin argument is greater than or equals the end argument, no character will be removed from this string.

If the begin argument is less than 0, 0 will be assumed to be specified. And if the end argument is greater than the length of this string, "the length of this string" will be assumed to be specified.

	Note
	This function will not change the content of this string.

Reference

SFXWideString::Insert

Return value

String obtained by replacing the specified substring in this string with the specified string.

Description

This function gets the string obtained by replacing the specified substring in this string with the specified string.

	Note
	The value that is less than or equals the length of the string specified in the fstring / tstring argument must be specified in the flength / tlength argument. If a negative value is specified, the length of the string specified in the fstring / tstring argument will be assumed to be set.

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

	Note
	This function will not change the content of this string.

Return value

Description

This function sets this string to the specified string, character, or buffer.

If the SFXAnsiString or SFXWideString instance is specified as an argument, its string value will be copied and set.

If the pointer to the AChar or WChar string is specified as an argument, the specified string will be regarded as the null-terminated string. Moreover, by specifying the length argument, a string including several null('\0') characters can be specified.

	Note
	The value that is less than or equals the length of the string specified in the string argument must be specified in the length argument. If a negative value is specified, the length of the null-terminated string specified in the string argument will be assumed to be set. The default value of the length argument is "-1".

	Note
	If this function fails due to insufficient memory, the content of this string will not be modified.

Reference

SFXWideString::SFXWideString | SFXWideString::operator=

Return value

Description

This function sets the specified character at the specified index of this string.

Concretely, the specified character will be set at the specified index of the internal buffer of this string.

	Note
	If the specified index is out of range of the internal buffer of this string or this string is empty, SFERR_INVALID_PARAM will be returned.

Reference

SFXWideString::GetBuffer | SFXWideString::GetChar

Description

This function sets the minimum unit to allocate the internal buffer memory(SFXClusterHeap) of this string to the specified value. [in bytes]

Default: SFXWideString::DEFAULT_CLUSTER bytes

For the value of SFXWideString::DEFAULT_CLUSTER, see SFXWideString::DefaultEnum.

Reference

SFXWideString::GetCluster | SFXWideString::DefaultEnum | SFXClusterHeap::SetCluster | SFXClusterHeap

Return value

Description

This function sets the length of this string to the specified value.

If the specified length is shorter than this string, the characters after the specified length of this string will be lost. On the other hand, if the specified length is longer than this string, this string will be extended with a null('\0') character.

Reference

SFXWideString::GetLength | SFXWideString::GetLengthCString

Description

This function sets the minimum memory of the internal buffer memory(SFXClusterHeap) of this string to the specified value. [in bytes]

Default: SFXWideString::DEFAULT_THRESHOLD bytes

For the value of SFXWideString::DEFAULT_THRESHOLD, see SFXWideString::DefaultEnum.

Reference

SFXWideString::GetThreshold | SFXWideString::DefaultEnum | SFXClusterHeap::SetThreshold | SFXClusterHeap

Return value

Description

This function checks whether or not this string starts with the specified string.

Reference

SFXWideString::EndsWith

Return value

Description

This function deletes the specified string at the end of this string.

If this string ends with the specified string, the specified string will be deleted from this string. Otherwise, nothing will happen.

If the pointer to the WChar string is specified as an argument, the specified string will be regarded as the null-terminated string. Moreover, by specifying the length argument, a string including several null('\0') characters can be specified.

	Note
	The value that is less than or equals the length of the string specified in the string argument must be specified in the length argument. If a negative value is specified, the length of the null-terminated string specified in the string argument will be assumed to be set. The default value of the length argument is "-1".

	Tip
	This function influences the content of this string. If you want to keep it unmodified, use the operator- operator.

Reference

SFXWideString::operator-= | operator- | operator+

Return value

Sub-string in the specified range of this string.

Description

This function gets the sub-string in the specified range of this string.

The string from the ("begin" + 1)th character to the ("end")th character will be returned. Its length is (end - begin).

If the begin argument is greater than or equals the end argument, the null string is returned.

If the begin argument is less than 0, 0 will be assumed to be specified. And if the end argument is greater than the length of this string, "the length of this string" will be assumed to be specified.

	Tip
	This string will not be modified after this function is executed.

Example

SFXWideString str1("American");
SFXWideString str2 = str1.Substring(2, 6);  // str2 = "eric"

Description

This function converts this string to lower-case.

	Note
	This function influences the content of this string. If you want to keep it unmodified, use the SFXWideString::AsLower function.

Reference

SFXWideString::ToUpper | SFXWideString::AsLower

Description

This function converts this string to upper-case.

	Note
	This function influences the content of this string. If you want to keep it unmodified, use the SFXWideString::AsUpper function.

Reference

SFXWideString::ToLower | SFXWideString::AsUpper

Return value

String obtained by trimming the blank characters or the specified string/character from the head and tail of this string.

Description

This function gets the string obtained by trimming the blank characters or the specified string/character from the head and tail of this string.

If no argument is specified, the blank characters(space, tab, vertical tab, linefeed, return, formfeed) will be trimmed from the head and tail of this string.

If arguments are specified, the specified string/character will be trimmed from the head and tail of this string.

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

	Note
	This function will not change the content of this string.

Example

SFXWideString str1("\t delicious beef ");
SFXWideString str2 = str1.Trim();        // str2 = "delicious beef"
SFXWideString str3 = str2.Trim("adef");  // str3 = "licious b"

Reference

SFXWideString::TrimLeft | SFXWideString::TrimRight

Return value

String obtained by trimming the blank characters or the specified string/character from the head of this string.

Description

This function gets the string obtained by trimming the blank characters or the specified string/character from the head of this string.

If no argument is specified, the blank characters(space, tab, vertical tab, linefeed, return, formfeed) will be trimmed from the head of this string.

If arguments are specified, the specified string/character will be trimmed from the head of this string.

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

	Note
	This function will not change the content of this string.

Example

SFXWideString str1("\t delicious beef ");
SFXWideString str2 = str1.TrimLeft();        // str2 = "delicious beef "
SFXWideString str3 = str2.TrimLeft("adef");  // str3 = "licious beef "

Reference

SFXWideString::Trim | SFXWideString::TrimRight

Return value

String obtained by trimming the blank characters or the specified string/character from the tail of this string.

Description

This function gets the string obtained by trimming the blank characters or the specified string/character from the tail of this string.

If no argument is specified, the blank characters(space, tab, vertical tab, linefeed, return, formfeed) will be trimmed from the tail of this string.

If arguments are specified, the specified string/character will be trimmed from the tail of this string.

	Tip
	Case sensitive comparison can be specified in the sensitive argument.

	Note
	This function will not change the content of this string.

Example

SFXWideString str1("\t delicious beef ");
SFXWideString str2 = str1.TrimRight();        // str2 = "\t delicious beef"
SFXWideString str3 = str2.TrimRight("adef");  // str3 = "\t delicious b"

Reference

SFXWideString::Trim | SFXWideString::TrimLeft

Return value

String until the first null('\0') character of this string.

	Note
	This function will not change the content of this string.

Description

This function gets the string until the first null('\0') character of this string.

Example

SFXWideString str1("abc\0abc", 7);
SFXWideString str2 = str1.Truncate(); // str2 = "abc"

Description

This operator assigns the right-hand string to the left-hand string.

If the SFXAnsiString or SFXWideString instance is specified as the right-hand string, it will be copied and assigned.

If the pointer to the AChar or WChar string is specified as the right-hand string, it will be regarded as the null-terminated string.

	Tip
	This operator influences the content of the left-hand string.

Reference

SFXWideString::Set | SFXWideString::SFXWideString

Return value

Description

This operator checks whether or not the left-hand string is the same with the right-hand string.

Reference

SFXWideString::Equals | operator!=

Return value

Description

This operator checks whether or not the left-hand string is greater than or equals the right-hand string.

Reference

SFXWideString::Compare | operator> | operator< | operator<=

Return value

Description

This operator checks whether or not the left-hand string is greater than the right-hand string.

Reference

SFXWideString::Compare | operator>= | operator< | operator<=

Description

This operator gets the character at the right-hand index of the left-hand string.

	Caution
	If the left-hand string is empty or the right-hand index is out of range of the left-hand string, null('\0') will be returned.

Reference

SFXWideString::GetChar

Description

This operator adds the right-hand string to the end of the left-hand string.

	Tip
	This operator influences the content of the left-hand string. This operator is very useful to concatenate multiple strings.

Example

SFXWideString str = "abc";
str << "def" << "ghi"; // str = "abcdefghi"

Reference

SFXWideString::Add | SFXWideString::operator+=

Return value

Description

This operator checks whether or not the left-hand string is less than or equals the right-hand string.

Reference

SFXWideString::Compare | operator> | operator>= | operator<

Return value

Description

This operator checks whether or not the left-hand string is less than the right-hand string.

Reference

SFXWideString::Compare | operator> | operator>= | operator<=

Description

This operator deletes the right-hand string from the end of the left-hand string.

If the right-hand string exists at the end of the left-hand string, the right-hand string will be deleted from the end of the left-hand string.

Otherwise, nothing will happen.

	Tip
	This operator influences the content of the left-hand string.

Reference

SFXWideString::Sub | operator-

Description

This operator returns the string obtained by deleting the right-hand string from the end of the left-hand string.

If the right-hand string exists at the end of the left-hand string, the string by deleting the right-hand string from the end of the left-hand string will be returned.

Otherwise, the left-hand string at it is will be returned.

Example

SFXWideString str1("Hello World");
SFXWideString str2(" World");
SFXWideString str3 = str1 - str2;   // str3 = "Hello"

Reference

SFXWideString::Sub SFXWideString::operator-=

Description

This operator repeats the left-hand string by the right-hand times.

	Tip
	This operator influences the content of the left-hand string.

Reference

SFXWideString::Mul | operator*

Description

This operator returns the string obtained by repeating the left-hand string by the right-hand times.

Reference

SFXWideString::Mul | SFXWideString::operator*=

Return value

Description

This operator checks whether or not the left-hand string is different from the right-hand string.

Reference

SFXWideString::Equals | operator==

Description

This operator adds the right-hand string to the end of the left-hand string.

	Tip
	This operator influences the content of the left-hand string.

Reference

SFXWideString::Add | operator+ | SFXWideString::operator<<

Description

This operator returns the string obtained by adding the right-hand string to the end of the left-hand string.

Reference

SFXWideString::Add | SFXWideString::operator+=

Description

DEFAULT_THRESHOLD and DEFAULT_CLUSTER are the constants that represent the default values for the minimum size and the cluster size of the internal buffer memory(SFXClusterHeap). [in bytes]

Reference

SFXWideString::SetCluster | SFXWideString::SetThreshold | SFXClusterHeap