|
Functions |
MQERETURN | mqeString_newChar8 (MQeExceptBlock *pErrStruct, MQeStringHndl *phNewString, MQECONST MQECHAR *pInput) |
| Creates a new MQeString and copies/converts the MQECHAR string pInput (each array element represents a Unicode code point) into the created MQeString.
|
MQERETURN | mqeString_newChar16 (MQeExceptBlock *pErrStruct, MQeStringHndl *phNewString, MQECONST MQECHAR16 *pInput) |
| Creates a new MQeString and copies/converts the MQECHAR16 string pInput (each array element represents a Unicode code point) into the created MQeString.
|
MQERETURN | mqeString_newChar32 (MQeExceptBlock *pErrStruct, MQeStringHndl *phNewString, MQECONST MQECHAR32 *pInput) |
| Creates a new MQeString and copies/converts the MQECHAR32 string pInput (each array element represents a Unicode code point) into the created MQeString.
|
MQERETURN | mqeString_newUtf8 (MQeExceptBlock *pErrStruct, MQeStringHndl *phNewString, MQECONST MQECHAR *pInput) |
| Creates a new MQeString and copies/converts the Unicode UTF-8 string pInput into the created MQeString.
|
MQERETURN | mqeString_newUtf16 (MQeExceptBlock *pErrStruct, MQeStringHndl *phNewString, MQECONST MQECHAR16 *pInput) |
| Creates a new MQeString and copies the Unicode UTF-16 string pInput (each array element represents a Unicode code point) into the created MQeString.It also supports surrogate pairs.
|
MQERETURN | mqeString_free (MQeStringHndl hString, MQeExceptBlock *pErrStruct) |
| Frees the MQeString pointed to by hString.
|
MQERETURN | mqeString_getChar8 (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQECHAR *pOutputString, MQEINT32 *pSize) |
| Copies (converts if the internal storage format is different) the text content of the MQeString hString into the MQECHAR buffer pointed to by pOutputString. The string will be stored in the C single byte string format. An error is raised if the string can not be converted into a single byte C string.
|
MQERETURN | mqeString_getChar16 (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQECHAR16 *pOutputString, MQEINT32 *pSize) |
| Copies (converts if the internal storage format is different) the text content of the MQeString hString into the MQECHAR16 buffer pointed to by pOutputString. The string will be stored in the UNICODE double-byte string format.
|
MQERETURN | mqeString_getChar32 (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQECHAR32 *pOutputString, MQEINT32 *pSize) |
| Copies (converts if the internal storage format is different) the text content of the MQeString hString into the MQECHAR32 buffer pointed to by pOutputString. The string will be stored in the UNICODE quad-byte string format.
|
MQERETURN | mqeString_getUtf8 (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQECHAR *pOutputString, MQEINT32 *pSize) |
| Copies (converts if the internal storage format is different) the text content of the MQeString hString into the buffer pointed to by pOutputString. The string will be stored in the UTF-8 format.
|
MQERETURN | mqeString_getUtf16 (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQECHAR16 *pOutputString, MQEINT32 *pSize) |
| Copies (converts if the internal storage format is different) the text content of the MQeString hString into the buffer pointed to by pOutputString. The string will be stored in the UTF-16 format.
|
MQERETURN | mqeString_equalTo (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQEBOOL *pIsEqual, MQECONST MQeStringHndl hEqualToString) |
| Compare the text content of hString with that of hEqualToString for exact equality (storage format independent).
|
MQERETURN | mqeString_codePointSize (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQEINT32 *pSize) |
| Find the number of bytes required to store the largest code point in the string.
|
MQERETURN | mqeString_isAsciiOnly (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQEBOOL *pIsAsciiOnly) |
| Check if hString contains Ascii characters only, i.e. 32 <= val < 128 (can be represented in multi-byte form).
|
MQERETURN | mqeString_isNull (MQeStringHndl hString, MQeExceptBlock *pErrStruct, MQEBOOL *pIsNull) |
| Check if hString contains a NULL string.
|
The MQeString class contains user defined and system strings and is an abstraction of character strings. It allows a string to be created or retrieved in a number of formats such as arrays containing Unicode code points (each code point stored in a 1, 2, or 4 bytes memory space) and UTF-8. The current implementation only supports these external formats. MQeString is used throughout the API where a string is required.