mbsrtowcs(3)


NAME

   mbsrtowcs - convert a multibyte string to a wide-character string

SYNOPSIS

   #include <wchar.h>

   size_t mbsrtowcs(wchar_t *dest, const char **src,
                     size_t len, mbstate_t *ps);

DESCRIPTION

   If  dest  is  not NULL, the mbsrtowcs() function converts the multibyte
   string *src to a wide-character string starting at dest.  At  most  len
   wide  characters  are written to dest.  The shift state *ps is updated.
   The  conversion  is  effectively  performed   by   repeatedly   calling
   mbrtowc(dest,  *src, n, ps) where n is some positive number, as long as
   this call succeeds, and then incrementing dest by one and *src  by  the
   number of bytes consumed.  The conversion can stop for three reasons:

   1. An  invalid  multibyte sequence has been encountered.  In this case,
      *src is left pointing to the invalid multibyte sequence, (size_t) -1
      is returned, and errno is set to EILSEQ.

   2. len  non-L'\0'  wide  characters  have been stored at dest.  In this
      case, *src is left pointing to the next  multibyte  sequence  to  be
      converted,  and  the  number  of  wide characters written to dest is
      returned.

   3. The multibyte string has been completely  converted,  including  the
      terminating null wide character ('\0'), which has the side effect of
      bringing back *ps to the initial state.  In this case, *src  is  set
      to  NULL,  and  the  number  of  wide  characters  written  to dest,
      excluding the terminating null wide character, is returned.

   If dest is NULL, len is ignored, and the conversion proceeds as  above,
   except  that  the  converted  wide  characters  are  not written out to
   memory, and that no length limit exists.

   In both of the above cases, if ps is NULL,  a  static  anonymous  state
   known only to the mbsrtowcs() function is used instead.

   The  programmer  must  ensure  that there is room for at least len wide
   characters at dest.

RETURN VALUE

   The mbsrtowcs() function returns the number  of  wide  characters  that
   make  up the converted part of the wide-character string, not including
   the terminating null wide character.  If an invalid multibyte  sequence
   was encountered, (size_t) -1 is returned, and errno set to EILSEQ.

ATTRIBUTES

   For   an   explanation   of   the  terms  used  in  this  section,  see
   attributes(7).

   
   Interface    Attribute      Value                        
   
   mbsrtowcs()  Thread safety  MT-Unsafe race:mbsrtowcs/!ps 
   

CONFORMING TO

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

NOTES

   The behavior of mbsrtowcs() depends on the  LC_CTYPE  category  of  the
   current locale.

   Passing NULL as ps is not multithread safe.

SEE ALSO

   iconv(3), mbrtowc(3), mbsinit(3), mbsnrtowcs(3), mbstowcs(3)

COLOPHON

   This  page  is  part of release 4.09 of the Linux man-pages project.  A
   description of the project, information about reporting bugs,  and  the
   latest     version     of     this    page,    can    be    found    at
   https://www.kernel.org/doc/man-pages/.





Opportunity


Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.





Free Software


Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.


Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.





Free Books


The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.


Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.





Education


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.


Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.