mtext_from_data3m17n
Usage
MText* mtext_from_data (const void * data, int nitems, enum MTextFormat format)
Overview
Allocate a new M-text with specified data. The mtext_from_data() function allocates a new M-text whose character sequence is specified by array data of nitems elements. format specifies the format of data.
When format is either MTEXT_FORMAT_US_ASCII or MTEXT_FORMAT_UTF_8, the contents of data must be of the type unsigned char, and nitems counts by byte.
When format is either MTEXT_FORMAT_UTF_16LE or MTEXT_FORMAT_UTF_16BE, the contents of data must be of the type unsigned short, and nitems counts by unsigned short.
When format is either MTEXT_FORMAT_UTF_32LE or MTEXT_FORMAT_UTF_32BE, the contents of data must be of the type unsigned, and nitems counts by unsigned.
The character sequence of the M-text is not modifiable.
The contents of data must not be modified while the M-text is alive.
The allocated M-text will not be freed unless the user explicitly does so with the m17n_object_unref() function. Even in that case, data is not freed.
Return value
If the operation was successful, mtext_from_data() returns a pointer to the allocated M-text. Otherwise it returns NULL and assigns an error code to the external variable merror_code.
Errors
MERROR_MTEXT
Releases
8 releases since Debian 3.1 (Sarge); the text changed 2 times.