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