Query: mbrtowc
OS: osx
Section: 3
Links: osx man pages all man pages
Forums: unix linux community forum categories
Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar
MBRTOWC(3) BSD Library Functions Manual MBRTOWC(3)NAMEmbrtowc, mbrtowc_l -- convert a character to a wide-character code (restartable)LIBRARYStandard C Library (libc, -lc)SYNOPSIS#include <wchar.h> size_t mbrtowc(wchar_t *restrict pwc, const char *restrict s, size_t n, mbstate_t *restrict ps); #include <wchar.h> #include <xlocale.h> size_t mbrtowc_l(wchar_t *restrict pwc, const char *restrict s, size_t n, mbstate_t *restrict ps, locale_t loc);DESCRIPTIONThe mbrtowc() function inspects at most n bytes, pointed to by s, to determine the number of bytes needed to complete the next multibyte character. If a character can be completed, and pwc is not NULL, the wide character which is represented by s is stored in the wchar_t it points to. If s is NULL, mbrtowc() behaves as if pwc were NULL, s were an empty string (""), and n were 1. The mbstate_t argument, ps, is used to keep track of the shift state. If it is NULL, mbrtowc() uses an internal, static mbstate_t object, which is initialized to the initial conversion state at program startup. While the mbrtowc() function uses the current locale, the mbrtowc_l() function may be passed a locale directly. See xlocale(3) for more information.RETURN VALUESThe mbrtowc() functions returns: 0 The next n or fewer bytes represent the null wide character (L' '). >0 The next n or fewer bytes represent a valid character, mbrtowc() returns the number of bytes used to complete the multibyte charac- ter. (size_t)-2 The next n contribute to, but do not complete, a valid multibyte character sequence, and all n bytes have been processed. (size_t)-1 An encoding error has occurred. The next n or fewer bytes do not contribute to a valid multibyte character.ERRORSThe mbrtowc() function will fail if: [EILSEQ] An invalid multibyte sequence was detected. [EINVAL] The conversion state is invalid.SEE ALSOmbtowc(3), multibyte(3), setlocale(3), wcrtomb(3), xlocale(3)STANDARDSThe mbrtowc() function conforms to ISO/IEC 9899:1999 (``ISO C99'').BSDApril 8, 2004 BSD
Related Man Pages |
---|
mbrtowc(3) - freebsd |
mbrtowc(3) - redhat |
mbrtowc(3) - debian |
mbrtowc(3) - osx |
mbrtoc16(3) - freebsd |
Similar Topics in the Unix Linux Community |
---|
Characters in a single read |