mtext_data(3m17n)						 The m17n Library						 mtext_data(3m17n)

NAME

       mtext_data - Get information about the text data in M-text.

SYNOPSIS

       void* mtext_data (MText * mt, enum MTextFormat * fmt, int * nunits, int * pos_idx, int * unit_idx)

DESCRIPTION

       Get information about the text data in M-text. The mtext_data() function returns a pointer to the text data of M-text mt.  If fmt is not
       NULL, the format of the text data is stored in it. If nunits is not NULL, the number of units of the text data is stored in it.

       If pos_idx is not NULL and it points to a non-negative number, what it points to is a character position. In this case, the return value is
       a pointer to the text data of a character at that position.

       Otherwise, if unit_idx is not NULL, it points to a unit position. In this case, the return value is a pointer to the text data of a
       character containing that unit.

       The character position and unit position of the return value are stored in pos_idx and unit_dix respectively if they are not NULL.

       o If the format of the text data is MTEXT_FORMAT_US_ASCII or MTEXT_FORMAT_UTF_8, one unit is unsigned char.
       o If the format is MTEXT_FORMAT_UTF_16LE or MTEXT_FORMAT_UTF_16BE, one unit is unsigned short.
       o If the format is MTEXT_FORMAT_UTF_32LE or MTEXT_FORMAT_UTF_32BE, one unit is unsigned int.
COPYRIGHT

       Copyright (C) 2001 Information-technology Promotion Agency (IPA)
       Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology (AIST)
       Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License
       <http://www.gnu.org/licenses/fdl.html>.

Version 1.6.2							    12 Jan 2011 						 mtext_data(3m17n)