3ds Max C++ API Reference
|
#include <strclass.h>
Public Member Functions | |
WStr () | |
WStr (const wchar_t *wcstr) | |
WStr (const WStr &ws) | |
WStr (WStr &&ws) | |
WStr (const MaxSDK::Util::MaxString &ws) | |
WStr (const MaxSDK::Util::MaxStringCast< WCHAR > &ws) | |
WStr (const QString &qstring) | |
Conversion constructor, from QString. | |
~WStr () | |
wchar_t * | dataForWrite (size_t nchars=(size_t) -1) |
Returns a pointer to this string which can be written to with up to 'nchars' characters. | |
const wchar_t * | data () const |
operator const wchar_t * () const & | |
operator const wchar_t * () &&=delete | |
operator const wchar_t * () const &&=delete | |
operator QString () const | |
Conversion operator to QString. | |
void | Resize (int nchars) |
int | Length () const |
int | length () const |
int | ByteCount () const |
int | LanguageCharacterCount () const |
size_t | AllocatedChars () const |
bool | isNull () const |
WStr & | operator= (const WStr &ws) |
WStr & | operator= (WStr &&ws) |
WStr & | operator= (const MaxSDK::Util::MaxString &mstr) |
WStr & | operator= (const wchar_t *wcstr) |
WStr & | operator= (const MaxSDK::Util::MaxStringCast< WCHAR > &mstr) |
WStr | operator+ (const WStr &ws) const |
WStr & | operator+= (const WStr &ws) |
WStr & | Append (const WStr &ws) |
WStr & | append (const WStr &ws) |
WStr & | remove (int pos) |
WStr & | remove (int pos, int N) |
WStr | Substr (int start, int nchars) const |
wchar_t | operator[] (int i) const |
Returns the nth character of this string. | |
int | first (wchar_t c) const |
int | last (wchar_t c) const |
bool | operator== (const WStr &ws) const |
bool | operator== (wchar_t c) const |
bool | operator!= (const WStr &ws) const |
bool | operator!= (wchar_t c) const |
bool | operator< (const WStr &ws) const |
bool | operator<= (const WStr &ws) const |
bool | operator> (const WStr &ws) const |
bool | operator>= (const WStr &ws) const |
void | toUpper () |
void | toLower () |
int | printf (const wchar_t *format,...) |
Write a formatted string into this WStr. | |
int | printf (WStr format,...) |
int | printf_l (const wchar_t *format, const _locale_t theLocale,...) |
Write a formatted string into this WStr using specified locale. | |
int | vprintf (const wchar_t *format, va_list args) |
Write a formatted string into this WStr. | |
int | vprintf_l (const wchar_t *format, const _locale_t theLocale, va_list args) |
Write a formatted string into this WStr specified locale. | |
WStr | MultiByteCharacterSubString (int firstCharacterIndex, int numberOfMBCharacters) const |
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 |
const wchar_t * | ToMCHAR (size_t *length=NULL) const |
WStr | ToMSTR () const |
bool | EndsWith (const WStr &s, bool caseSensitive=true) const |
Returns true if the string ends with s; otherwise returns false. | |
bool | EndsWith (wchar_t c, bool caseSensitive=true) const |
Returns true if the string ends with c; otherwise returns false. | |
bool | StartsWith (const WStr &s, bool caseSensitive=true) const |
Returns true if the string starts with s; otherwise returns false. | |
bool | StartsWith (wchar_t c, bool caseSensitive=true) const |
Returns true if the string starts with c; otherwise returns false. | |
bool | CaseInsensitiveEqual (const wchar_t *string) const |
Returns true if the strings compared are the same (regardless of character casing); otherwise returns false. | |
bool | CaseInsensitiveEqual (const WStr &string) const |
size_t | NumberOfLines () const |
Returns the number of line feeds inside a string. | |
size_t | Replace (const wchar_t *pFind, const wchar_t *pReplaceBy, bool firstOnly=false, size_t startPosition=0) |
Replaces one substring with another in this string. | |
Static Public Member Functions | |
static WStr | FromBSTR (const wchar_t *string, size_t length=(size_t) -1) |
static WStr | FromCP (UINT cp, const char *string, size_t length=(size_t) -1) |
static WStr | FromACP (const char *string, size_t length=(size_t) -1) |
static WStr | FromUTF8 (const char *string, size_t length=(size_t) -1) |
static WStr | FromOLESTR (const wchar_t *string, size_t length=(size_t) -1) |
static WStr | FromUTF16 (const wchar_t *string, size_t length=(size_t) -1) |
static WStr | FromUTF32 (const unsigned int *string, size_t length=(size_t) -1) |
static WStr | FromMaxString (MaxSDK::Util::MaxString &string) |
static WStr | FromCStr (const CStr &string) |
static WStr | FromWStr (const WStr &string) |
static WStr | FromMCHAR (const wchar_t *string, size_t length=(size_t) -1) |
static WStr | FromMSTR (const WStr &string) |
![]() | |
static UtilExport void * | operator new (size_t size) |
Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e) |
Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new (size_t size, const char *filename, int line) |
New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, const char *filename, int line) |
New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new (size_t size, unsigned long flags) |
New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, unsigned long flags) |
New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size, const char *filename, int line) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate arrays of objects. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size, unsigned long flags) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void | operator delete (void *ptr) |
Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e) |
Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete (void *ptr, const char *filename, int line) |
Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, int block_type, const char *filename, int line) |
Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete (void *ptr, unsigned long flags) |
Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags) |
Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr) |
Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e) |
Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, int block_type, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr, unsigned long flags) |
Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags) |
Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, void *placement_ptr) |
Placement new operator. | |
static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
Placement delete operator. | |
static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
Allocates memory on a specified alignment boundary. | |
static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
Reallocates memory on a specified alignment boundary. | |
static UtilExport void | aligned_free (void *ptr) |
Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. | |
WStr | ( | ) |
WStr | ( | const wchar_t * | wcstr | ) |
WStr | ( | const MaxSDK::Util::MaxString & | ws | ) |
WStr | ( | const MaxSDK::Util::MaxStringCast< WCHAR > & | ws | ) |
WStr | ( | const QString & | qstring | ) |
Conversion constructor, from QString.
~WStr | ( | ) |
Returns a pointer to this string which can be written to with up to 'nchars' characters.
nchars | The minimum number of characters to allocate in the string buffer (excluding the terminating null character). A value of -1 specifies that the existing buffer should be re-used. |
const wchar_t * data | ( | ) | const |
operator const wchar_t * | ( | ) | const & |
|
delete |
|
delete |
operator QString | ( | ) | const |
Conversion operator to QString.
int Length | ( | ) | const |
|
inline |
int ByteCount | ( | ) | const |
int LanguageCharacterCount | ( | ) | const |
This may be equal or less than the amount of WCHAR used to store the string in memory. For example, a chinese character might take two WCHARs. Length() will count the character as two distinct WCHARs. LanguageCharacterCount() will count it as a single character.
size_t AllocatedChars | ( | ) | const |
|
inline |
WStr & operator= | ( | const MaxSDK::Util::MaxString & | mstr | ) |
WStr & operator= | ( | const wchar_t * | wcstr | ) |
WStr & operator= | ( | const MaxSDK::Util::MaxStringCast< WCHAR > & | mstr | ) |
wchar_t 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 WStr::MultiByteCharacterSubString instead.
i | Index of that character. |
int first | ( | wchar_t | c | ) | const |
int last | ( | wchar_t | c | ) | const |
bool operator== | ( | const WStr & | ws | ) | const |
bool operator== | ( | wchar_t | c | ) | const |
bool operator!= | ( | const WStr & | ws | ) | const |
bool operator!= | ( | wchar_t | c | ) | const |
bool operator< | ( | const WStr & | ws | ) | const |
bool operator<= | ( | const WStr & | ws | ) | const |
bool operator> | ( | const WStr & | ws | ) | const |
bool operator>= | ( | const WStr & | ws | ) | const |
void toUpper | ( | ) |
void toLower | ( | ) |
int printf | ( | const wchar_t * | format, |
... | |||
) |
Write a formatted string into this WStr.
Writes the format string, filled in by the optional arguments into this WStr. 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 printf_l | ( | const wchar_t * | format, |
const _locale_t | theLocale, | ||
... | |||
) |
Write a formatted string into this WStr using specified locale.
Writes the format string, filled in by the optional arguments into this WStr. See the ISO C++ documentation for more information on printf_l and format strings.
format | Specifies how to format the destination string. |
theLocale | The locale to use. |
... | optional arguments to format into the destination string. |
int vprintf | ( | const wchar_t * | format, |
va_list | args | ||
) |
Write a formatted string into this WStr.
This method is similar to WStr::printf. Instead of taking a variable list of arguments as parameter, it takes a structure representing a variable list of arguments. This allows WStr objects to be used to build strings based on a format string and a variable number of arguments:
int vprintf_l | ( | const wchar_t * | format, |
const _locale_t | theLocale, | ||
va_list | args | ||
) |
Write a formatted string into this WStr specified locale.
This method is similar to WStr::printf_l. Instead of taking a variable list of arguments as parameter, it takes a structure representing a variable list of arguments. This allows WStr objects to be used to build strings based on a format string, a locale, and a variable number of arguments:
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 |
|
inlinestatic |
CStr ToCStr | ( | ) | const |
|
inline |
|
inline |
bool EndsWith | ( | const WStr & | s, |
bool | caseSensitive = true |
||
) | const |
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 | ( | wchar_t | c, |
bool | caseSensitive = true |
||
) | const |
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 WStr & | s, |
bool | caseSensitive = true |
||
) | const |
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 | ( | wchar_t | c, |
bool | caseSensitive = true |
||
) | const |
Returns true if the string starts with c; otherwise returns false.
This function overloads StartsWith().
c | The character to be searched. |
caseSensitive | If it is true(default), the search is case sensitive; otherwise the search is case insensitive. |
bool CaseInsensitiveEqual | ( | const wchar_t * | string | ) | const |
Returns true if the strings compared are the same (regardless of character casing); otherwise returns false.
string | The string compared with. |
bool CaseInsensitiveEqual | ( | const WStr & | string | ) | const |
size_t NumberOfLines | ( | ) | const |
Returns the number of line feeds inside a string.
size_t Replace | ( | const wchar_t * | pFind, |
const wchar_t * | 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 |