This reference page is linked to from the following overview topics: Guidelines for Handling Character Strings, Unicode, wchar_t is Now Treated as a Type.
#include <strclass.h>
Public Member Functions |
|
CStr () | |
CStr (const char *cs) | |
CStr (const CStr &ws) | |
CStr (const MaxSDK::Util::MaxString &ws) | |
CStr (const MaxSDK::Util::MaxStringCast< char > &ws) | |
~CStr () | |
char * | dataForWrite (size_t nchars=(size_t)-1) |
const char * | data () const |
operator const char * () const | |
void | Resize (int nchars) |
int | Length () const |
int | length () const |
int | ByteCount () const |
int | LanguageCharacterCount () const |
size_t | AllocatedChars () const |
bool | isNull () const |
CStr & | operator= (const CStr &cs) |
CStr & | operator= (const MaxSDK::Util::MaxString &mstr) |
CStr & | operator= (const MaxSDK::Util::MaxStringCast< char > &mstr) |
CStr & | operator= (const char *cs) |
CStr | operator+ (const CStr &cs) const |
CStr & | operator+= (const CStr &cs) |
CStr & | Append (const CStr &cs) |
CStr & | append (const CStr &cs) |
CStr & | remove (int pos) |
CStr & | remove (int pos, int N) |
CStr | Substr (int start, int nchars) const |
CStr | MultiByteCharacterSubString (int firstCharacterIndex, int numberOfMBCharacters) const |
int | FindMultiByteCharacterFirstByteIndex (int characterIndex) const |
int | FindMultiByteCharacterLastByteIndex (int characterIndex) const |
char | operator[] (int i) const |
Returns the nth character of this string.
|
|
int | first (char c) const |
int | last (char c) const |
bool | operator== (const CStr &cs) const |
bool | operator== (char c) const |
bool | operator!= (const CStr &cs) const |
bool | operator!= (char c) const |
bool | operator< (const CStr &cs) const |
bool | operator<= (const CStr &ws) const |
bool | operator> (const CStr &ws) const |
bool | operator>= (const CStr &ws) const |
void | toUpper () |
void | toLower () |
int | printf (const char *format,...) |
Write a formatted string into this CStr. |
|
int | vprintf (const char *format, va_list args) |
Write a formatted string into this CStr. |
|
wchar_t * | ToBSTR () const |
MaxSDK::Util::MaxStringCastCP | ToCP (UINT cp, size_t *length=NULL) const |
MaxSDK::Util::MaxStringCast< char > | ToACP (size_t *length=NULL) const |
MaxSDK::Util::MaxStringCastUTF8 | ToUTF8 (size_t *length=NULL) const |
MaxSDK::Util::MaxStringCast < WCHAR > |
ToOLESTR (size_t *length=NULL) const |
MaxSDK::Util::MaxStringCast < WCHAR > |
ToUTF16 (size_t *length=NULL) const |
MaxSDK::Util::MaxStringCast < unsigned int > |
ToUTF32 (size_t *length=NULL) const |
MaxSDK::Util::MaxString | ToMaxString () const |
void | ToMaxString (MaxSDK::Util::MaxString &) const |
CStr | ToCStr () const |
WStr | ToWStr () const |
MaxSDK::Util::MaxStringCast< char > | ToMCHAR (size_t *length=NULL) const |
CStr | ToMSTR () const |
bool | EndsWith (const CStr &s, bool caseSensitive=true) |
Returns true if the string ends with s;
otherwise returns false. |
|
bool | EndsWith (char c, bool caseSensitive=true) |
Returns true if the string ends with c;
otherwise returns false. |
|
bool | StartsWith (const CStr &s, bool caseSensitive=true) |
Returns true if the string starts with s;
otherwise returns false. |
|
bool | StartsWith (char c, bool caseSensitive=true) |
Returns true if the string starts with c;
otherwise returns false. |
|
size_t | NumberOfLines () const |
Returns the number of lines inside a string.
|
|
size_t | Replace (const char *pFind, const char *pReplaceBy, bool firstOnly=false, size_t startPosition=0) |
Replaces one substring with another in this
string. |
|
Static Public Member Functions |
|
static CStr | FromBSTR (const wchar_t *string, size_t length=(size_t)-1) |
static CStr | FromCP (UINT cp, const char *string, size_t length=(size_t)-1) |
static CStr | FromACP (const char *string, size_t length=(size_t)-1) |
static CStr | FromUTF8 (const char *string, size_t length=(size_t)-1) |
static CStr | FromOLESTR (const wchar_t *string, size_t length=(size_t)-1) |
static CStr | FromUTF16 (const wchar_t *string, size_t length=(size_t)-1) |
static CStr | FromUTF32 (const unsigned int *string, size_t length=(size_t)-1) |
static CStr | FromMaxString (MaxSDK::Util::MaxString &string) |
static CStr | FromCStr (const CStr &string) |
static CStr | FromWStr (const WStr &string) |
static CStr | FromMCHAR (const char *string, size_t length=(size_t)-1) |
static CStr | FromMSTR (const CStr &string) |
CStr | ( | ) |
CStr | ( | const char * | cs | ) |
CStr | ( | const MaxSDK::Util::MaxString & | ws | ) |
CStr | ( | const MaxSDK::Util::MaxStringCast< char > & | ws | ) |
~CStr | ( | ) |
char* dataForWrite | ( | size_t | nchars =
(size_t)-1 |
) |
const char* data | ( | ) | const |
operator const char * | ( | ) | const |
void Resize | ( | int | nchars | ) |
int Length | ( | ) | const [inline] |
{ return ByteCount(); }
int length | ( | ) | const [inline] |
{ return Length(); }
int ByteCount | ( | ) | const |
int LanguageCharacterCount | ( | ) | const |
size_t AllocatedChars | ( | ) | const |
bool isNull | ( | ) | const [inline] |
{ return data()[0]==0; }
CStr& operator= | ( | const MaxSDK::Util::MaxString & | mstr | ) |
CStr& operator= | ( | const MaxSDK::Util::MaxStringCast< char > & | mstr | ) |
CStr& operator= | ( | const char * | cs | ) |
Assignment operator.
{ return ((*this) += cs); }
{ return ((*this) += cs); }
CStr& remove | ( | int | pos | ) |
CStr& remove | ( | int | pos, |
int | N | ||
) |
CStr Substr | ( | int | start, |
int | nchars | ||
) | const |
CStr MultiByteCharacterSubString | ( | int | firstCharacterIndex, |
int | numberOfMBCharacters | ||
) | const |
int FindMultiByteCharacterFirstByteIndex | ( | int | characterIndex | ) | const |
int FindMultiByteCharacterLastByteIndex | ( | int | characterIndex | ) | const |
char operator[] | ( | int | i | ) | const |
Returns the nth character of this string.
Warning: In some environment, this function may return a partial character, especially for asiatic languages. If you intend to do any advance transformation or interpretation of the returned data, you should consider calling CStr::MultiByteCharacterSubString instead.
i | Index of that character. |
int first | ( | char | c | ) | const |
int last | ( | char | c | ) | const |
bool operator== | ( | const CStr & | cs | ) | const |
bool operator== | ( | char | c | ) | const |
bool operator!= | ( | const CStr & | cs | ) | const |
bool operator!= | ( | char | c | ) | const |
bool operator< | ( | const CStr & | cs | ) | const |
bool operator<= | ( | const CStr & | ws | ) | const |
bool operator> | ( | const CStr & | ws | ) | const |
bool operator>= | ( | const CStr & | ws | ) | const |
void toUpper | ( | ) |
void toLower | ( | ) |
int printf | ( | const char * | format, |
... | |||
) |
Write a formatted string into this CStr.
Writes the format string, filled in by the optional arguments into this CStr. See the ISO C++ documentation for more information on printf and format strings.
format | Specifies how to format the destination string. |
... | optional arguments to format into the destination string. |
int vprintf | ( | const char * | format, |
va_list | args | ||
) |
Write a formatted string into this CStr.
This method is similar to CStr::printf. Instead of taking a variable list of arguments as parameter, it takes a structure representing a variable list of argument. This allows CStr objects to be used to build strings based on a format string and a variable number of arguments:
wchar_t* ToBSTR | ( | ) | const |
static CStr FromBSTR | ( | const wchar_t * | string, |
size_t | length =
(size_t)-1 |
||
) | [static] |
MaxSDK::Util::MaxStringCastCP ToCP | ( | UINT | cp, |
size_t * | length =
NULL |
||
) | const |
static CStr FromCP | ( | UINT | cp, |
const char * | string, | ||
size_t | length =
(size_t)-1 |
||
) | [static] |
MaxSDK::Util::MaxStringCast<char> ToACP | ( | size_t * | length = NULL |
) | const |
static CStr FromACP | ( | const char * | string, |
size_t | length =
(size_t)-1 |
||
) | [static] |
MaxSDK::Util::MaxStringCastUTF8 ToUTF8 | ( | size_t * | length = NULL |
) | const |
static CStr FromUTF8 | ( | const char * | string, |
size_t | length =
(size_t)-1 |
||
) | [static] |
MaxSDK::Util::MaxStringCast<WCHAR> ToOLESTR | ( | size_t * | length = NULL |
) | const |
static CStr FromOLESTR | ( | const wchar_t * | string, |
size_t | length =
(size_t)-1 |
||
) | [static] |
MaxSDK::Util::MaxStringCast<WCHAR> ToUTF16 | ( | size_t * | length = NULL |
) | const |
static CStr FromUTF16 | ( | const wchar_t * | string, |
size_t | length =
(size_t)-1 |
||
) | [static] |
MaxSDK::Util::MaxStringCast<unsigned int> ToUTF32 | ( | size_t * | length = NULL |
) | const |
static CStr FromUTF32 | ( | const unsigned int * | string, |
size_t | length =
(size_t)-1 |
||
) | [static] |
MaxSDK::Util::MaxString ToMaxString | ( | ) | const |
void ToMaxString | ( | MaxSDK::Util::MaxString & | ) | const |
static CStr FromMaxString | ( | MaxSDK::Util::MaxString & | string | ) | [inline, static] |
{ return CStr(string); }
CStr ToCStr | ( | ) | const [inline] |
{ return *this; }
{ return CStr(string); }
WStr ToWStr | ( | ) | const |
MaxSDK::Util::MaxStringCast<char> ToMCHAR | ( | size_t * | length = NULL |
) | const [inline] |
static CStr FromMCHAR | ( | const char * | string, |
size_t | length =
(size_t)-1 |
||
) | [inline, static] |
CStr ToMSTR | ( | ) | const [inline] |
{ return *this; }
{ return CStr(string); }
bool EndsWith | ( | const CStr & | s, |
bool | caseSensitive =
true |
||
) |
Returns true if the string ends with s; otherwise returns false.
s | The string to be searched. |
caseSensitive | If it is true(default), the search is case sensitive; otherwise the search is case insensitive. |
bool EndsWith | ( | char | c, |
bool | caseSensitive =
true |
||
) |
Returns true if the string ends with c; otherwise returns false.
This function overloads EndsWith().
c | The character to be searched. |
caseSensitive | If it is true(default), the search is case sensitive; otherwise the search is case insensitive. |
bool StartsWith | ( | const CStr & | s, |
bool | caseSensitive =
true |
||
) |
Returns true if the string starts with s; otherwise returns false.
s | The string to be searched. |
caseSensitive | If it is true(default), the search is case sensitive; otherwise the search is case insensitive. |
bool StartsWith | ( | char | c, |
bool | caseSensitive =
true |
||
) |
Returns true if the string starts with c; otherwise returns false.
c | The character to be searched. |
caseSensitive | If it is true(default), the search is case sensitive; otherwise the search is case insensitive. |
size_t NumberOfLines | ( | ) | const |
Returns the number of lines inside a string.
size_t Replace | ( | const char * | pFind, |
const char * | pReplaceBy, | ||
bool | firstOnly = false , |
||
size_t | startPosition =
0 |
||
) |
Replaces one substring with another in this string.
pFind | The substring to be replaced. |
pReplaceBy | The string the substring is to be replaced with. |
firstOnly | If true, only first occurrence of 'from' is replaced, otherwise all occurrences are replaced |
startPosition | The character position to start searching from |