mbrtowc(3c) 맨 페이지 - 윈디하나의 솔라나라

개요

섹션
맨 페이지 이름
검색(S)

mbrtowc(3c)

mbrtowc(3C)              Standard C Library Functions              mbrtowc(3C)

NAME
       mbrtowc - convert a character to a wide-character code (restartable)

SYNOPSIS
       #include <wchar.h>

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

DESCRIPTION
       If  s  is not a null pointer, the mbrtowc() function inspects at most n
       bytes beginning at the byte pointed to by s to determine the number  of
       bytes  needed  to  complete the next character (including any shift se‐
       quences). If the function determines that the next  character  is  com‐
       pleted, it determines the value of the corresponding wide-character and
       then,  if  pwc  is  not a null pointer, stores that value in the object
       pointed to by pwc. If the  corresponding  wide-character  is  the  null
       wide-character, the resulting state described is the initial conversion
       state.


       If  s  is  a  null  pointer,  the  mbrtowc()  function is equivalent to
       mbrtowc(NULL, "", 1, ps); and the values of the arguments pwc and n are
       ignored.


       If ps is a null pointer, the mbrtowc() function uses its  own  internal
       mbstate_t  object,  which is initialized at program startup to the ini‐
       tial conversion state. Otherwise, the mbstate_t object pointed to by ps
       is used to completely describe the current conversion state of the  as‐
       sociated  character sequence. Solaris will behave as if no function de‐
       fined in the Solaris Reference Manual calls mbrtowc().


       The behavior of this function is affected by the LC_CTYPE  category  of
       the current locale. See environ(7).

RETURN VALUES
       The mbrtowc() function returns the first of the following that applies:

       0                If  the  next  n or fewer bytes complete the character
                        that corresponds to the null wide-character (which  is
                        the value stored).


       positive         If  the next n or fewer bytes complete a valid charac‐
                        ter (which is the value stored); the value returned is
                        the number of bytes that complete the character.


       (size_t)−2       If the next n bytes contribute to  an  incomplete  but
                        potentially valid character, and all n bytes have been
                        processed  (no  value  is stored). When n has at least
                        the value of the MB_CUR_MAX macro, this case can  only
                        occur if s points at a sequence of redundant shift se‐
                        quences  (for implementations with state-dependent en‐
                        codings).


       (size_t)−1       If an encoding error occurs, in which case the next  n
                        or  fewer  bytes  do  not contribute to a complete and
                        valid character (no value is stored).  In  this  case,
                        EILSEQ  is stored in errno and the conversion state is
                        undefined.


ERRORS
       The mbrtowc() function may fail if:

       EINVAL    The ps argument points to an object that contains an  invalid
                 conversion state.


       EILSEQ    Invalid character sequence is detected.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:

       tab()  box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) ATTRIBUTE TYPEAT‐
       TRIBUTE VALUE _ Interface  StabilityCommitted  _  MT-LevelSee  below  _
       StandardSee standards(7).


   MT-Level
       If  ps  is  not  a  null  pointer,  mbrtowc() uses the mbstate_t object
       pointed to by ps and the function can be used safely  in  multithreaded
       applications,  as  long  as setlocale(3C) is not being called to change
       the locale. If ps is a null pointer, mbrtowc() uses  its  internal  mb‐
       state_t  object  and  the  function is Unsafe in multithreaded applica‐
       tions.

SEE ALSO
       mbsinit(3C), setlocale(3C), attributes(7), environ(7), standards(7)


       Handling Characters and Character Strings in Internationalizing and Lo‐
       calizing Applications in Oracle Solaris

HISTORY
       The mbrtowc() function was added to Solaris in the Solaris 7 release.

Oracle Solaris 11.4               25 Nov 2024                      mbrtowc(3C)
맨 페이지 내용의 저작권은 맨 페이지 작성자에게 있습니다.
RSS ATOM XHTML 5 CSS3