ИМЯ

mbrtowc - преобразовывает мультибайтовую последовательность в широкий символ

ОБЗОР

#include <wchar.h>

size_t mbrtowc(wchar_t *pwc, const char *s, size_t n, mbstate_t *ps);

ОПИСАНИЕ

В основном, функция предназначена для работы, когда s и pwc не равны NULL. В этом случае функция mbrtowc() просматривает не более n байт многобайтовой строки, начинающейся с s, извлекает следующий полный многобайтовый символ, преобразует его в широкий символ и сохраняет его в *pwc. При этом обновляется состояние сдвига *ps. Если преобразованный широкий символ не равен L'\0' (широкий символ null), то возвращается количество байт, которое было выбрано из s. Если преобразованный широкий символ равен L'\0', то состояние сдвига *ps сбрасывается в начальное состояние и возвращается 0.

Если в n байтах, начиная с s, не содержится полного многобайтового символа, то mbrtowc() возвращает (size_t) -2. Это может произойти даже, если n >= MB_CUR_MAX, если в многобайтовой строке содержится лишние сдвиговые последовательности.

Если многобайтовая строка, начинающаяся с s, содержит некорректную многобайтовую последовательность до следующего полного символа, то mbrtowc() возвращает (size_t) -1 и присваивает errno значение EILSEQ. В этом случае влияние на *ps не определено.

Ещё случай, когда s не равно NULL, а pwc равно NULL. В этом случае функция mbrtowc() действует как описано выше, но не сохраняет преобразованный широкий символ в памяти.

И третий случай, когда s равно NULL. В этом случае pwc и n игнорируются. Если состояние преобразования, представляемое *ps означает неполный многобайтовый символ, то функция mbrtowc() возвращает (size_t) -1, присваивает errno значение EILSEQ и оставляет *ps в неопределённом состоянии. Иначе функция mbrtowc() изменяет *ps в начальное состояние и возвращает 0.

Во всех вышеперечисленных случаях, если ps равно NULL, то используется статическое анонимное состояние, известное только функции mbrtowc(). Иначе *ps должен быть корректным объектом mbstate_t. Объект mbstate_t a может быть переведён в начальное состояние, если его обнулить, например с помощью

memset(&a, 0, sizeof(a));

ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ

Функция mbrtowc() возвращает количество байт, просмотренных в многобайтовой последовательности, начинающейся с s, если при этом был получен широкий символ не равный L'\0'. Она возвращает 0, если был получен широкий символ L'\0'. Она возвращает (size_t) -1 и присваивает errno значение EILSEQ, если встречена некорректная многобайтовая последовательность. Она возвращает (size_t) -2, если не удалось найти полную многобайтовую последовательность, что означает, что n должно быть увеличено.

АТРИБУТЫ

Описание терминов данного раздела смотрите в attributes(7).

СООТВЕТСТВИЕ СТАНДАРТАМ

POSIX.1-2001, POSIX.1-2008, C99.

ЗАМЕЧАНИЯ

Поведение mbrtowc() зависит от категории LC_CTYPE текущей локали.

СМОТРИТЕ ТАКЖЕ

mbsinit(3), mbsrtowcs(3)