ncurses 6.0 - patch 20170128
[ncurses.git] / doc / html / man / curs_move.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,2017 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_move.3x,v 1.15 2017/01/07 19:25:15 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_move 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_move 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>                                             <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>move</STRONG>, <STRONG>wmove</STRONG> - move <STRONG>curses</STRONG> window cursor
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
54
55        <STRONG>int</STRONG> <STRONG>move(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
56        <STRONG>int</STRONG> <STRONG>wmove(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        These  routines move the cursor associated with the window
61        to line <EM>y</EM> and column <EM>x</EM>.  This routine does  not  move  the
62        physical  cursor  of  the  terminal  until  <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG> is
63        called.  The position specified is relative to  the  upper
64        left-hand corner of the window, which is (0,0).
65
66
67 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
68        These routines return <STRONG>ERR</STRONG> upon failure and OK (SVr4 speci-
69        fies only "an integer value other than <STRONG>ERR</STRONG>") upon success-
70        ful completion.
71
72        Specifically,  they  return an error if the window pointer
73        is null, or if the position is outside the window.
74
75
76 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
77        Note that <STRONG>move</STRONG> may be a macro.
78
79
80 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
81        These functions are described in the XSI Curses  standard,
82        Issue 4.
83
84
85 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
86        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
87
88
89
90                                                           <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>
91 </PRE>
92 <div class="nav">
93 <ul>
94 <li><a href="#h2-NAME">NAME</a></li>
95 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
96 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
97 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
98 <li><a href="#h2-NOTES">NOTES</a></li>
99 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
100 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
101 </ul>
102 </div>
103 </BODY>
104 </HTML>