ncurses 6.2 - patch 20210626
[ncurses.git] / doc / html / man / curs_inwstr.3x.html
index 7000e113a199309cc1165dd7a7b40712efddad4c..411094ffd0eecaadbfa5afe820481d2e6309dd0e 100644 (file)
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_inwstr 3X</TITLE>
+<TITLE>curs_inwstr 3x</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_inwstr 3X</H1>
+<H1 class="no-header">curs_inwstr 3x</H1>
 <PRE>
-<B><A HREF="curs_inwstr.3X.html">curs_inwstr(3X)</A></B>                                                <B><A HREF="curs_inwstr.3X.html">curs_inwstr(3X)</A></B>
+<STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>                                                <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <B>inwstr</B>,  <B>innwstr</B>,  <B>winwstr</B>,  <B>winnwstr</B>,  <B>mvinwstr</B>, <B>mvinnwstr</B>, <B>mvwinwstr</B>,
-       <B>mvwinnwstr</B> - get a string of <B>wchar_t</B> characters from a curses window
+       <STRONG>inwstr</STRONG>,  <STRONG>innwstr</STRONG>,  <STRONG>winwstr</STRONG>,  <STRONG>winnwstr</STRONG>,  <STRONG>mvinwstr</STRONG>, <STRONG>mvinnwstr</STRONG>, <STRONG>mvwinwstr</STRONG>,
+       <STRONG>mvwinnwstr</STRONG> - get a string of <STRONG>wchar_t</STRONG> characters from a curses window
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
-       <B>int</B> <B>inwstr(wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
-       <B>int</B> <B>innwstr(wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
-       <B>int</B> <B>winwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
-       <B>int</B> <B>winnwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>inwstr(wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>innwstr(wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>winwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>winnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
 
-       <B>int</B> <B>mvinwstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
-       <B>int</B> <B>mvinnwstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
-       <B>int</B> <B>mvwinwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
-       <B>int</B> <B>mvwinnwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>mvinwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>mvinnwstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>mvwinwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>mvwinnwstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wchar_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-       These routines return a string of  <B>wchar_t</B>  wide  characters  in  <I>wstr</I>,
+       These routines return a string of  <STRONG>wchar_t</STRONG>  wide  characters  in  <EM>wstr</EM>,
        extracted starting at the current cursor position in the named window.
 
-       The  four  functions  with  <I>n</I>  as  the  last  argument return a leading
-       substring at most <I>n</I> characters long (exclusive of  the  trailing  NUL).
-       Transfer  stops  at  the  end of the current line, or when <I>n</I> characters
-       have been stored at the location referenced by <I>wstr</I>.
+       The  four  functions  with  <EM>n</EM>  as  the  last  argument return a leading
+       substring at most <EM>n</EM> characters long (exclusive of  the  trailing  NUL).
+       Transfer  stops  at  the  end of the current line, or when <EM>n</EM> characters
+       have been stored at the location referenced by <EM>wstr</EM>.
 
-       If the size  <I>n</I>  is  not  large  enough  to  store  a  complete  complex
+       If the size  <EM>n</EM>  is  not  large  enough  to  store  a  complete  complex
        character, an error is generated.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       All routines except <B>winnwstr</B> may be macros.
+       All routines except <STRONG>winnwstr</STRONG> may be macros.
 
        Each  cell  in  the  window  holds a complex character (i.e., base- and
        combining-characters)  together  with  attributes  and  color.    These
        functions  store  only  the  wide  characters,  ignoring attributes and
-       color.  Use <B>in_wchstr</B> to return the complex characters from a window.
+       color.  Use <STRONG>in_wchstr</STRONG> to return the complex characters from a window.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       All routines return <B>ERR</B> upon failure.  Upon successful completion,  the
-       *<B>inwstr</B> routines return <B>OK</B>, and the *<B>innwstr</B> routines return the number
+       All routines return <STRONG>ERR</STRONG> upon failure.  Upon successful completion,  the
+       *<STRONG>inwstr</STRONG> routines return <STRONG>OK</STRONG>, and the *<STRONG>innwstr</STRONG> routines return the number
        of characters read into the string.
 
        Functions with a "mv" prefix first  perform  a  cursor  movement  using
-       <B>wmove</B>, and return an error if the position is outside the window, or if
+       <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
        the window pointer is null.
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>, <B><A HREF="curs_in_wchstr.3X.html">curs_in_wchstr(3X)</A></B>
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>, <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
 
 
 
-                                                               <B><A HREF="curs_inwstr.3X.html">curs_inwstr(3X)</A></B>
+                                                               <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>