ncurses 6.2 - patch 20210626
[ncurses.git] / doc / html / man / curs_instr.3x.html
index 89ab99c1585b6cf85926bcb932b1660224ff43aa..b783e98fce9386c3b8fa3b7b9ae43a708de2b5df 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_instr 3X</TITLE>
+<TITLE>curs_instr 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_instr 3X</H1>
+<H1 class="no-header">curs_instr 3x</H1>
 <PRE>
-<B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>                                                  <B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>
+<STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>                                                  <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <B>instr</B>,  <B>innstr</B>, <B>winstr</B>, <B>winnstr</B>, <B>mvinstr</B>, <B>mvinnstr</B>, <B>mvwinstr</B>, <B>mvwinnstr</B>
-       - get a string of characters from a <B>curses</B> window
+       <STRONG>instr</STRONG>,  <STRONG>innstr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwinstr</STRONG>, <STRONG>mvwinnstr</STRONG>
+       - get a string of characters from a <STRONG>curses</STRONG> 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>instr(char</B> <B>*</B><I>str</I><B>);</B>
-       <B>int</B> <B>innstr(char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
-       <B>int</B> <B>winstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
-       <B>int</B> <B>winnstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>innstr(char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>winstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>winnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
 
-       <B>int</B> <B>mvinstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
-       <B>int</B> <B>mvinnstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
-       <B>int</B> <B>mvwinstr(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>char</B> <B>*</B><I>str</I><B>);</B>
-       <B>int</B> <B>mvwinnstr(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>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>mvinstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>mvinnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>mvwinstr(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>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>mvwinnstr(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>char</STRONG> <STRONG>*</STRONG><EM>str</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 characters in <I>str</I>, extracted starting
+       These routines return a string of characters in <EM>str</EM>, extracted starting
        at  the  current  cursor  position in the named window.  Attributes are
-       stripped from the characters.  The four functions with <I>n</I>  as  the  last
-       argument   return  a  leading  substring  at  most  <I>n</I>  characters  long
+       stripped from the characters.  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).
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       All of the  functions  return  <B>ERR</B>  upon  failure,  or  the  number  of
+       All of the  functions  return  <STRONG>ERR</STRONG>  upon  failure,  or  the  number  of
        characters actually read into the string.
 
        X/Open Curses defines no error conditions.  In this implementation:
 
-       <B>o</B>   If the <I>win</I> parameter is null, an error is returned,
+       <STRONG>o</STRONG>   If the <EM>win</EM> parameter is null, an error is returned,
 
-       <B>o</B>   If the <I>chstr</I> parameter is null, an error is returned,
+       <STRONG>o</STRONG>   If the <EM>chstr</EM> parameter is null, an error is returned,
 
        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-NOTES">NOTES</a></H2><PRE>
-       Note that all routines except <B>winnstr</B> may be macros.
+       Note that all routines except <STRONG>winnstr</STRONG> may be macros.
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
        trailing NUL.
 
        The ncurses library extends the XSI description by allowing a  negative
-       value  for  <I>n</I>.  In this case, the functions return the string ending at
+       value  for  <EM>n</EM>.  In this case, the functions return the string ending at
        the right margin.
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <B><A HREF="curses.3X.html">curses(3X)</A></B>.
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
 
 
 
-                                                                <B><A HREF="curs_instr.3X.html">curs_instr(3X)</A></B>
+                                                                <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>