#include <MString.h>
Manipulate strings.
The MString class implements a string class, and is used to pass all string arguments to Maya API methods.
The MString class supports localized strings. Use of the MString class to store and manipulate strings largely insulates the code from locale-dependent processing. Code that uses the class and its methods will in most cases operate seamlessly in both multibyte and single-byte environments. Knowledge of the underlying string storage mechanism or encoding is not required to use the class, and assumptions about this should not be made by the calling code.
Unless otherwise indicated, MString methods accepting or returning string contents via character buffers (char *) use the convention that the string contents are in the locale's native multibyte encoding. Methods which explicitly support other common encodings and representations such as UTF-8 and wchar_t are also provided. Code that manipulates string contents should use the multibyte-safe methods provided by the class. Refer to documentation on individual MString methods for more information.
Public Member Functions | |
MString () | |
The Class constructor. More... | |
MString (const char *charString) | |
Class constructor. More... | |
MString (const wchar_t *charString) | |
Class constructor. More... | |
MString (const char *charString, int charLength) | |
Class constructor. More... | |
MString (const wchar_t *charString, int wcharLength) | |
Class constructor. More... | |
MString (const MString &other) | |
Copy constructor. More... | |
~MString () | |
The class destructor. | |
MString & | operator+= (const MString &other) |
In-place addition with another MString. More... | |
MString & | operator+= (const char *other) |
In-place addition with a C++ string. More... | |
MString & | operator+= (double other) |
In-place addition with a double value. More... | |
MString & | operator+= (int other) |
In-place addition with an int value. More... | |
MString & | operator+= (unsigned int other) |
In-place addition with an unsigned int value. More... | |
MString & | operator+= (float other) |
In-place addition with a float value. More... | |
MString & | operator= (const MString &other) |
Assignment operator. More... | |
MString & | operator= (const char *other) |
Assignment operator. More... | |
MString & | operator= (double value) |
Assignment operator. More... | |
bool | operator== (const MString &other) const |
Equality operator. More... | |
bool | operator== (const char *other) const |
Equality operator. More... | |
bool | operator!= (const MString &other) const |
Inequality operator. More... | |
bool | operator!= (const char *other) const |
Inequality operator. More... | |
MString | operator+ (const MString &other) const |
Addition with another MString. More... | |
MString | operator+ (const char *other) const |
Addition with a C++ string. More... | |
MString | operator+ (double value) const |
Addition with a double value. More... | |
MStatus | set (const char *charString) |
Set the value of the string in this MString instance. More... | |
MStatus | setUTF8 (const char *utf8String) |
Set the value of the string in this MString instance using a null-terminated utf-8 encoded character string. More... | |
MStatus | setWChar (const wchar_t *wcharString) |
Set the value of the string in this MString instance using a null-terminated wide character string. More... | |
MStatus | set (const char *charString, int charLength) |
Set the value of the string in this MString instance to the value of the character buffer passed. More... | |
MStatus | setWChar (const wchar_t *wcharString, int wcharLength) |
Set the value of the string in this MString instance using a wide string and its length. More... | |
MStatus | set (double value) |
Set the value of the string in this MString instance. More... | |
MStatus | set (double value, int precision) |
Set the value of the string in this MString instance, with the given precision. More... | |
const char * | asChar () const |
Return the current string in this MString instance as a C++ char* pointer. More... | |
const char * | asChar (int &charLength) const |
Return the current string in this MString instance as a C++ char* pointer. More... | |
const char * | asUTF8 () const |
Return the current string in this MString instance as a C++ char* pointer to a null-terminated utf-8 encoded string. More... | |
const char * | asUTF8 (int &utf8Length) const |
Return the current string in this MString instance as a C++ char* pointer to a null-terminated utf-8 encoded string. More... | |
const wchar_t * | asWChar () const |
Return the current string in this MString instance as pointer to a null terminated wide character (wchar_t) buffer. More... | |
const wchar_t * | asWChar (int &numChars) const |
Return the current string in this MString instance as pointer to a null terminated wide character (wchar_t) buffer. More... | |
unsigned int | length () const |
Returns the length of the string buffer in this MString instance. More... | |
unsigned int | numChars () const |
Returns the number of characters in the MString instance. More... | |
void | clear () |
Clears the contents of this MString instance and sets it value to the empty string. | |
int | index (char) const |
Returns the position of the first occurance of the character searchChar in the string or -1 if the character is not found. More... | |
int | indexW (char) const |
Returns the position of the first occurance of the character searchChar in the string or -1 if the character is not found. More... | |
int | indexW (wchar_t) const |
Returns the position of the first occurance of the wide character searchChar in the string or -1 if the character is not found. More... | |
int | indexW (const MString &) const |
Returns the position of the first occurance of the searchString in the string or -1 if it is not found. More... | |
int | rindex (char) const |
Returns the position of the last occurance of the character searchChar in the string or -1 if the character is not found. More... | |
int | rindexW (char) const |
Returns the position of the last occurance of the character searchChar in the string or -1 if the character is not found. More... | |
int | rindexW (wchar_t) const |
Returns the position of the last occurance of the wide character searchChar in the string or -1 if the character is not found. More... | |
int | rindexW (const MString &) const |
Returns the position of the last occurance of the searchString in the string or -1 if it is not found. More... | |
MStatus | split (char, MStringArray &) const |
Split the string up at each occurrence of theChar and place the separate strings into theArray. More... | |
MStatus | split (wchar_t, MStringArray &) const |
Split the string up at each occurrence of the given wide character and place the separate strings into theArray. More... | |
MString | substring (int start, int end) const |
Return a new MString instance that contains the characters from start to end inclusive. More... | |
MString | substringW (int start, int end) const |
Return a new MString instance that contains the characters from start to end inclusive. More... | |
MString & | toUpperCase () |
Modify the current instance of the string replacing all lower case characters in the corresponding upper case characters. More... | |
MString & | toLowerCase () |
Modify the current instance of the string replacing all lower case characters in the corresponding upper case characters. More... | |
bool | isShort () const |
Returns true if the string represents a valid short, and false otherwise. More... | |
short | asShort () const |
Returns the value of the string in this MString instance converted to a short. More... | |
bool | isInt () const |
Returns true if the string represents a valid int, and false otherwise. More... | |
int | asInt () const |
Returns the value of the string in this MString instance converted to an integer. More... | |
bool | isUnsigned () const |
Returns true if the string represents a valid unsigned int, and false otherwise. More... | |
unsigned int | asUnsigned () const |
Returns the value of the string in this MString instance converted to an unsigned integer. More... | |
bool | isFloat () const |
Returns true if the string represents a valid float, and false otherwise. More... | |
float | asFloat () const |
Returns the value of the string in this MString instance converted to a float. More... | |
bool | isDouble () const |
Returns true if the string represents a valid double, and false otherwise. More... | |
double | asDouble () const |
Returns the value of the string in this MString instance converted to a double. More... | |
MString | expandEnvironmentVariablesAndTilde (MStatus *ReturnStatus=NULL) const |
Returns a new string constructed by duplicating the current string with all environment variables expanded (and on UNIX, tilde characaters ("~") are also expanded. More... | |
MString | expandFilePath (MStatus *ReturnStatus=NULL) const |
Returns a new string constructed by duplicating the current string with all environment variables expanded (and on UNIX, tilde characaters ("~") are also expanded. More... | |
MStatus | format (const MString &fmt, const MStringArray &args) |
Format the string value using a format specifier and an array of positional arguments. More... | |
MStatus | format (const MString &fmt, const MString &arg1=MString::argUnused, const MString &arg2=MString::argUnused, const MString &arg3=MString::argUnused, const MString &arg4=MString::argUnused, const MString &arg5=MString::argUnused, const MString &arg6=MString::argUnused, const MString &arg7=MString::argUnused, const MString &arg8=MString::argUnused, const MString &arg9=MString::argUnused, const MString &arg10=MString::argUnused) |
Format the string value using a format specifier and positional arguments. More... | |
MStatus | substitute (const MString &src, const MString &target) |
Replace all occurrences of src in this string with target. More... | |
MStatus | substituteFirst (const MString &src, const MString &target) |
Replace the first occurrence of src in this string with target. More... | |
Friends | |
OPENMAYA_EXPORT std::ostream & | operator<< (std::ostream &, const MString &) |
NO SCRIPT SUPPORT. More... | |
OPENMAYA_EXPORT MString | operator+ (const char *, const MString &) |
NO SCRIPT SUPPORT. More... | |
MString | ( | const char * | charString | ) |
Class constructor.
Create a new instance of an MString and initialize it to the given null-terminated character string.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | charString | the initial string value (null-terminated) |
MString | ( | const wchar_t * | wcharString | ) |
Class constructor.
Create a new instance of an MString and initialize it with the null-terminated wide character string.
[in] | wcharString | the initial string value (null-terminated). |
MString | ( | const char * | charString, |
int | charLength | ||
) |
Class constructor.
Create a new instance of an MString and initialize it with the character buffer passed, to the specified length. The length value is the length in bytes of the character buffer passed.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | charString | the initial string value. |
[in] | charLength | the initial string length. |
MString | ( | const wchar_t * | wcharString, |
int | wcharLength | ||
) |
Class constructor.
Create a new instance of an MString and initialize it to the given wide character string of specified length.
The length value corresponds to the number of wide characters in the initialization string.
[in] | wcharString | the initial string value. |
[in] | wcharLength | the initial string length (number of characters). |
MString & operator+= | ( | const char * | other | ) |
In-place addition with a C++ string.
The character string on the right is appended to the MString on the left and the result is placed in the MString.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | other | Right operand. |
MString & operator+= | ( | double | other | ) |
MString & operator+= | ( | int | other | ) |
MString & operator+= | ( | unsigned int | other | ) |
MString & operator+= | ( | float | other | ) |
Assignment operator.
Allows assignment between MString instances.
[in] | other | Value to be assigned. |
MString & operator= | ( | const char * | other | ) |
MString & operator= | ( | double | value | ) |
bool operator== | ( | const MString & | other | ) | const |
Equality operator.
Allows two MStrings to be compared to see if they contain identical strings.
[in] | other | Right operand. |
bool operator== | ( | const char * | other | ) | const |
Equality operator.
Allows an MString and the contents of a character buffer to be compared to see if they contain identical strings.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | other | Right operand. |
bool operator!= | ( | const MString & | other | ) | const |
Inequality operator.
Allows two MStrings to be compared to see if they differ.
[in] | other | Right operand. |
bool operator!= | ( | const char * | other | ) | const |
Inequality operator.
Allows an MString to be compared with the contents of a character buffer to see if the two strings differ.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | other | Right operand. |
MString operator+ | ( | const char * | other | ) | const |
Addition with a C++ string.
The character string on the right is appended to the MString on the left and the result is returned in a new MString. Neither of the operands is modified.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | other | Right operand. |
MString operator+ | ( | double | value | ) | const |
MStatus set | ( | const char * | charString | ) |
Set the value of the string in this MString instance.
to the value of the null-terminated character string.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | charString | new string value (null-terminated). |
MStatus setUTF8 | ( | const char * | utf8String | ) |
Set the value of the string in this MString instance using a null-terminated utf-8 encoded character string.
Note: conversion errors may occur if the multibyte encoding of the current locale cannot represent the utf-8 characters in the assignment string.
[in] | utf8String | null-terminated utf-8 character string buffer. |
MStatus setWChar | ( | const wchar_t * | wcharString | ) |
Set the value of the string in this MString instance using a null-terminated wide character string.
[in] | wcharString | null-terminated wide character string buffer. |
MStatus set | ( | const char * | charString, |
int | charLength | ||
) |
Set the value of the string in this MString instance to the value of the character buffer passed.
The length value is the length in bytes of the character buffer.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | charString | new string value. |
[in] | charLength | new string length. |
MStatus setWChar | ( | const wchar_t * | wcharString, |
int | wcharLength | ||
) |
Set the value of the string in this MString instance using a wide string and its length.
The length value corresponds to the number of wide characters in the input string.
[in] | wcharString | New wide character string value. |
[in] | wcharLength | New string length (number of wide characters) |
MStatus set | ( | double | value | ) |
Set the value of the string in this MString instance.
The numeric value will be converted to a character string.
[in] | value | new number. |
MStatus set | ( | double | value, |
int | precision | ||
) |
Set the value of the string in this MString instance, with the given precision.
The numeric value will be converted to a character string.
[in] | value | new number. |
[in] | precision | the precision (number of decimal places). |
const char * asChar | ( | ) | const |
Return the current string in this MString instance as a C++ char* pointer.
The string will be returned as a null-terminated buffer of type char.
In a localized environment, the string will contain a buffer of multibyte characters in the locale's native encoding.
The length of this representation of the string can be obtained by calling the alternate version of this method that returns the string length, or by calling MString::length().
NOTE: The string should be duplicated if it will be re-used.
const char * asChar | ( | int & | charLength | ) | const |
Return the current string in this MString instance as a C++ char* pointer.
The string will be returned as a null-terminated buffer of type char.
In a localized environment, the string will contain a buffer of multibyte characters in the locale's native encoding.
The argument passed will be used to return the length of the character buffer returned in bytes (excluding the trailing null).
NOTE: the length value corresponds to the string's character length in bytes, which can differ from the number of characters in the string when running in a localized environment.
NOTE: The string should be duplicated if it will be re-used.
[out] | charLength | value which will be set to the length of the character buffer returned |
const char * asUTF8 | ( | ) | const |
Return the current string in this MString instance as a C++ char* pointer to a null-terminated utf-8 encoded string.
The length of this buffer can be obtained by calling the alternate form of MString::asUTF8 which returns the length value.
NOTE: The string should be duplicated if it will be re-used.
const char * asUTF8 | ( | int & | utf8Length | ) | const |
Return the current string in this MString instance as a C++ char* pointer to a null-terminated utf-8 encoded string.
The integer argument passed will be used to return the length of this buffer (in bytes) excluding the trailing null.
NOTE: The string should be duplicated if it will be re-used.
[out] | utf8Length | Value which will be set to the length of the character buffer returned. |
const wchar_t * asWChar | ( | ) | const |
Return the current string in this MString instance as pointer to a null terminated wide character (wchar_t) buffer.
The number of characters in this buffer will be equivalent to MString::numChars, or can be determined by using the alternate form of MString::awWChar which returns the buffer length.
NOTE: wchar_t types are not portable between platforms and are not recommended for persistent data. A portable multibyte format such as UTF-8 is recommended for file I/O.
NOTE: The string should be duplicated if it will be re-used.
const wchar_t * asWChar | ( | int & | wcharLength | ) | const |
Return the current string in this MString instance as pointer to a null terminated wide character (wchar_t) buffer.
The length value returned corresponds to the number of wide characters in the buffer returned (excluding the trailing null).
NOTE: wchar_t types are not portable between platforms and are not recommended for persistent data. A portable multibyte format such as UTF-8 is recommended for file I/O.
NOTE: The string should be duplicated if it will be re-used.
[out] | wcharLength | number of wide characters in buffer returned |
unsigned int length | ( | ) | const |
Returns the length of the string buffer in this MString instance.
This value corresponds to the length, in bytes, of the charcter buffer returned from the MString::asChar method, excluding the trailing null.
NOTE: When running in a localized (multibyte) environment, the MString::asChar method will return a multibyte buffer, in which the number of characters in the string may not correspond to the number of bytes in the multibyte representation. The use of the MString::numChars method is recommended in place of MString::length for determining the number of individual characters in the string.
unsigned int numChars | ( | ) | const |
Returns the number of characters in the MString instance.
NOTE: this value corresponds to the number of actual characters in the string, not its character buffer length. It is suitable for localized environments as it correctly handles multibyte characters.
int index | ( | char | searchChar | ) | const |
Returns the position of the first occurance of the character searchChar in the string or -1 if the character is not found.
The position value returned from index is a byte-based charcter position corresponding to the location in the asChar() form of the string.
NOTE: since this version of index works on the char form of the string it is not reliable within localized (multibyte) environments as the positions returned may not correctly match character boundaries in the multibyte buffer. Use of MString::indexW is recommended instead.
[in] | searchChar | the character to search for |
int indexW | ( | char | searchChar | ) | const |
Returns the position of the first occurance of the character searchChar in the string or -1 if the character is not found.
The position value returned from indexW is a character-based position and correctly handles strings in localized (multibyte) environments. Use of MString::indexW over MString::index is recommended.
[in] | searchChar | the character to search for |
int indexW | ( | wchar_t | searchChar | ) | const |
Returns the position of the first occurance of the wide character searchChar in the string or -1 if the character is not found.
The position value returned from indexW is a character-based position and correctly handles strings in localized (multibyte) environments. Use of MString::indexW over MString::index is recommended.
[in] | searchChar | the wide character to search for |
int indexW | ( | const MString & | searchStr | ) | const |
Returns the position of the first occurance of the searchString in the string or -1 if it is not found.
The position value returned from indexW is a character-based position and correctly handles strings in localized (multibyte) environments.
[in] | searchStr | The string to search for. |
int rindex | ( | char | searchChar | ) | const |
Returns the position of the last occurance of the character searchChar in the string or -1 if the character is not found.
The position value returned from rindex is a byte-based character position corresponding to the location in the asChar() form of the string.
NOTE: since this version of rindex works on the char form of the string it is not reliable within localized (multibyte) environments as the positions returned may not correctly match character boundaries in the multibyte buffer. Use of MString::rindexW is recommended instead.
[in] | searchChar | the character to search for |
int rindexW | ( | char | searchChar | ) | const |
Returns the position of the last occurance of the character searchChar in the string or -1 if the character is not found.
The position value returned from rindexW is a character-based position and correctly handles strings in localized (multibyte) environments. Use of MString::indexW over MString::index is recommended.
[in] | searchChar | the character to search for |
int rindexW | ( | wchar_t | searchChar | ) | const |
Returns the position of the last occurance of the wide character searchChar in the string or -1 if the character is not found.
The position value returned from rindexW is a character-based position and correctly handles strings in localized (multibyte) environments. Use of MString::indexW over MString::index is recommended.
[in] | searchChar | the character to search for |
int rindexW | ( | const MString & | searchStr | ) | const |
Returns the position of the last occurance of the searchString in the string or -1 if it is not found.
The position value returned from indexW is a character-based position and correctly handles strings in localized (multibyte) environments.
[in] | searchStr | the string to search for |
MStatus split | ( | char | theChar, |
MStringArray & | theArray | ||
) | const |
Split the string up at each occurrence of theChar and place the separate strings into theArray.
The current string instance is not modified.
NOTE: for compatibilty in localized environments an alternate form of of MString::split that accept wide-characters is also provided.
[in] | theChar | the character on which to split |
[out] | theArray | the MStringArray to populate |
MStatus split | ( | wchar_t | theWChar, |
MStringArray & | theArray | ||
) | const |
Split the string up at each occurrence of the given wide character and place the separate strings into theArray.
The current string instance is not modified.
NOTE: this method accepts a wide character type and is the preferred format for compatibility in localized environments.
[in] | theWChar | the character on which to split |
[out] | theArray | the MStringArray to populate |
MString substring | ( | int | start, |
int | end | ||
) | const |
Return a new MString instance that contains the characters from start to end inclusive.
Start and end are byte-based positions corresponding to the asChar() form of the string.
NOTE: since this version of substring works on the char form of the string it is not compatible with localized (multibyte) environments as the positions specified may not correctly match character boundaries in the multibyte buffer. Use of MString::substringW is recommended instead.
[in] | start | the index of the first character to copy |
[in] | end | the index of the last character to copy |
MString substringW | ( | int | start, |
int | end | ||
) | const |
Return a new MString instance that contains the characters from start to end inclusive.
Start and end are character-based positions and correctly deal with multibyte strings in localized environments.
NOTE: use of MString::substringW over MString::substring is recommended
[in] | start | the index of the first character to copy |
[in] | end | the index of the last character to copy |
MString & toUpperCase | ( | ) |
Modify the current instance of the string replacing all lower case characters in the corresponding upper case characters.
MString & toLowerCase | ( | ) |
Modify the current instance of the string replacing all lower case characters in the corresponding upper case characters.
bool isShort | ( | ) | const |
Returns true if the string represents a valid short, and false otherwise.
short asShort | ( | ) | const |
Returns the value of the string in this MString instance converted to a short.
If the string does contain a valid string representation of a short, then the results of this operation are undefined.
bool isInt | ( | ) | const |
Returns true if the string represents a valid int, and false otherwise.
int asInt | ( | ) | const |
Returns the value of the string in this MString instance converted to an integer.
If the string does contain a valid string representation of an integer, then the results of this operation are undefined.
bool isUnsigned | ( | ) | const |
Returns true if the string represents a valid unsigned int, and false otherwise.
unsigned int asUnsigned | ( | ) | const |
Returns the value of the string in this MString instance converted to an unsigned integer.
If the string does contain a valid string representation of an unsigned integer, then the results of this operation are undefined.
bool isFloat | ( | ) | const |
Returns true if the string represents a valid float, and false otherwise.
float asFloat | ( | ) | const |
Returns the value of the string in this MString instance converted to a float.
If the string does contain a valid string representation of a float, then the results of this operation are undefined.
bool isDouble | ( | ) | const |
Returns true if the string represents a valid double, and false otherwise.
double asDouble | ( | ) | const |
Returns the value of the string in this MString instance converted to a double.
If the string does contain a valid string representation of a double, then the results of this operation are undefined.
Returns a new string constructed by duplicating the current string with all environment variables expanded (and on UNIX, tilde characaters ("~") are also expanded.
Environment variables may be of the form $ENV_VAR or ${ENV_VAR}. On Windows, ENV_VAR, ENV_VAR% and %{ENV_VAR}% are also accepted. If no environment variable in the system matches that given, the unexpanded variable is copied verbatim into the result string. On UNIX, any tilde characters ("~") will also be expanded according to the standard UNIX convention. If the user name associated with a tilde is undefined, the tilde and name which follows it are copied verbatim into the result string. Notes (1) when any error occurs, processing continues such that all subsequent environment variable and tilde occurences are processed and the resulting string can be displayed to the user to help diagnose the undefined entities (2) escape sequences using backslash characters are not supported.
[out] | ReturnStatus | Status code |
Returns a new string constructed by duplicating the current string with all environment variables expanded (and on UNIX, tilde characaters ("~") are also expanded.
Environment variables may be of the form $ENV_VAR or ${ENV_VAR}. On Windows, ENV_VAR, ENV_VAR% and %{ENV_VAR}% are also accepted. If no environment variable in the system matches that given, the unexpanded variable is copied verbatim into the result string. On UNIX, any tilde characters ("~") will also be expanded according to the standard UNIX convention. If the user name associated with a tilde is undefined, the tilde and name which follows it are copied verbatim into the result string. Notes (1) when any error occurs, processing continues such that all subsequent environment variable and tilde occurences are processed and the resulting string can be displayed to the user to help diagnose the undefined entities (2) escape sequences using backslash characters are not supported.
This does some file-path specific expansion. So if we have an invalid sequence like $A;;$B or $A::$B (on Mac/Linux), it will be collapsed to $A;$B or $A:$B respectively, then expanded.
We also do file-path specific nested environment variable expansion. So if you have $A/foo, and $A = "A;a", this will result in, A/foo;a/foo instead of A;a/foo. If you want A;a/foo, use MString::expandEnvironmentVariablesAndTilde
[out] | ReturnStatus | Status code |
MStatus format | ( | const MString & | fmt, |
const MStringArray & | args | ||
) |
Format the string value using a format specifier and an array of positional arguments.
A maximum of 10 arguments may be specified in the array passed. The number of arguments must match exactly the number of arguments expected by the format statement.
All arguments are passed as MStrings (any numeric data for example must already be formatted by the caller into an MString).
Format specifiers determine the relative position and ordering of arguments in the string using specifiers of the form: ^1s ^2s ^3s etc. See also the mel format command.
[in] | fmt | format string (up to 10 positional argument specifiers) |
[in] | args | array of arguments to be positioned in the format string |
MStatus format | ( | const MString & | fmt, |
const MString & | arg1 = MString::argUnused , |
||
const MString & | arg2 = MString::argUnused , |
||
const MString & | arg3 = MString::argUnused , |
||
const MString & | arg4 = MString::argUnused , |
||
const MString & | arg5 = MString::argUnused , |
||
const MString & | arg6 = MString::argUnused , |
||
const MString & | arg7 = MString::argUnused , |
||
const MString & | arg8 = MString::argUnused , |
||
const MString & | arg9 = MString::argUnused , |
||
const MString & | arg10 = MString::argUnused |
||
) |
Format the string value using a format specifier and positional arguments.
A maximum of 10 argument strings may be passed in the argument list. This routine accepts a variable number of arguments in the argument list. Unused arguments should not be passed. (i.e. if 3 arguments are required by the format statement, exactly 3 arguments should be passed when calling MString::format).
All arguments are passed as MStrings (any numeric data for example must already be converted by the caller to an MString).
Format specifiers determine the relative position and ordering of arguments in the string using specifiers of the form: ^1s ^2s ^3s etc. See also the mel format command for more information.
[in] | fmt | format string (up to 10 positional arguments) |
[in] | arg1 | argument to be positioned in the format string |
[in] | arg2 | argument to be positioned in the format string |
[in] | arg3 | argument to be positioned in the format string |
[in] | arg4 | argument to be positioned in the format string |
[in] | arg5 | argument to be positioned in the format string |
[in] | arg6 | argument to be positioned in the format string |
[in] | arg7 | argument to be positioned in the format string |
[in] | arg8 | argument to be positioned in the format string |
[in] | arg9 | argument to be positioned in the format string |
[in] | arg10 | argument to be positioned in the format string |
Replace all occurrences of src in this string with target.
[in] | src | The string to search for |
[in] | target | The replacement string |
Replace the first occurrence of src in this string with target.
[in] | src | The string to search for |
[in] | target | The replacement string |
|
friend |
NO SCRIPT SUPPORT.
[in] | s | the ostream to print to |
[in] | str | the MString whose value is to be printed |
NO SCRIPT SUPPORT.
The MString on the right is appended to the character string on the left and the result is returned in a new MString. Neither of the operands is modified.
NOTE: in multibyte locales, the character buffer encoding is assumed to be the native multibyte encoding of the current locale.
[in] | first | Left operand. |
[in] | second | Right operand. |