wcsnrtombs(3)


NAME

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

SYNOPSIS

   #include <wchar.h>

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

   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

   wcsnrtombs():
       Since glibc 2.10:
           _POSIX_C_SOURCE >= 200809L
       Before glibc 2.10:
           _GNU_SOURCE

DESCRIPTION

   The  wcsnrtombs()  function  is  like the wcsrtombs(3) function, except
   that the number of wide characters to be converted, starting  at  *src,
   is limited to nwc.

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

   1. A wide character has been encountered that can not be represented as
      a multibyte sequence (according to the  current  locale).   In  this
      case,   *src  is  left  pointing  to  the  invalid  wide  character,
      (size_t) -1 is returned, and errno is set to EILSEQ.

   2. nwc wide characters have been converted without encountering a  null
      wide  character (L'\0'), or the length limit forces a stop.  In this
      case, *src is left  pointing  to  the  next  wide  character  to  be
      converted, and the number of bytes written to dest is returned.

   3. The  wide-character  string has been completely converted, including
      the terminating null wide character (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 bytes  written  to  dest,  excluding  the
      terminating null byte ('\0'), is returned.

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

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

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

RETURN VALUE

   The  wcsnrtombs() function returns the number of bytes that make up the
   converted part of multibyte sequence,  not  including  the  terminating
   null  byte.   If  a  wide  character was encountered which could not be
   converted, (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                         
   
   wcsnrtombs()  Thread safety  MT-Unsafe race:wcsnrtombs/!ps 
   

CONFORMING TO

   POSIX.1-2008.

NOTES

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

   Passing NULL as ps is not multithread safe.

SEE ALSO

   iconv(3), mbsinit(3), wcsrtombs(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/.


More Linux Commands

manpages/XGrabDeviceButton.3.html
XGrabDeviceButton(3) - grab/ungrab extension input device bu
The XGrabDeviceButton request establishes a passive grab. In the future, the device is actively grabbed (as for XGrabDevice, the last-grab time is set to the ti

manpages/Tk_GetHWND.3.html
Tk_GetHWND(3) - manage interactions between the Windows hand
Tk_GetHWND returns the Windows HWND identifier for X Windows window given by window. Tk_AttachHWND binds the Windows HWND identifier to the specified Tk_Window

manpages/snmptrap.1.html
snmptrap(1) - sends an SNMP notification to a manager.......
snmptrap is an SNMP application that uses the SNMP TRAP operation to send information to a network manager. One or more object identifiers (OIDs) can be given a

manpages/continue.n.html
continue(n) - Skip to the next iteration of a loop (ManPage)
This command is typically invoked inside the body of a looping command such as for or foreach or while. It returns a 4 (TCL_CONTINUE) result code, which causes

manpages/getfsent.3.html
getfsent(3) - handle fstab entries - Linux manual page......
These functions read from the file /etc/fstab. The struct fstab is defined by: struct fstab { char *fs_spec; /* block device name */ char *fs_file; /* mount poi

manpages/automake-1.13.1.html
automake-1.13(1) manual page for automake 1.13.4 (Man Page)
automake-1.13.1 - Generate Makefile.in for configure from Makefile.am. Operation modes: --help print this help, then exit --version print version number, then e

manpages/sasl_authorize_t.3.html
sasl_authorize_t(3) - The SASL authorization callback.......
sasl_authorize_t is used to check whether the authorized user auth_identity may act as the user requested_user. For example the user root may wish to authentica

manpages/tc-hfsc.8.html
tc-hfsc(8) Hierarchical Fair Service Curves control under li
HFSC qdisc has only one optional parameter default. CLASSID specifies the minor part of the default classid, where packets not classified by other will be ...

manpages/XSetCloseDownMode.3.html
XSetCloseDownMode(3) - control clients - Linux manual page
The XSetCloseDownMode defines what will happen to the clients resources at connection close. A connection starts in DestroyAll mode. For information on what hap

manpages/readdir.3.html
readdir(3) - read a directory (Library - Linux man page)....
The readdir() function returns a pointer to a dirent structure representing the next directory entry in the directory stream pointed to by dirp. It returns NULL

manpages/auparse_feed.3.html
auparse_feed(3) - feed data into parser - Linux manual page
auparse_feed supplies new data for the parser to consume. auparse_init() must have been called with a source type of AUSOURCE_FEED and a NULL pointer. The parse

manpages/socketpair.2.html
socketpair(2) - create a pair of connected sockets (ManPage)
The socketpair() call creates an unnamed pair of connected sockets in the specified domain, of the specified type, and using the optionally specified protocol.





We can't live, work or learn in freedom unless the software we use is free.