ncurses 6.2 - patch 20210213
[ncurses.git] / man / curs_legacy.3x
index fa0930fe3ac27605667cb3db35d943965804c952..c2eb86b8834c2c20a9f415ea2c240ab951b3c677 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************
-.\" Copyright (c) 2007-2015,2017 Free Software Foundation, Inc.              *
+.\" Copyright 2019,2020 Thomas E. Dickey                                     *
+.\" Copyright 2007-2015,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
@@ -26,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_legacy.3x,v 1.7 2017/11/19 00:23:58 tom Exp $
+.\" $Id: curs_legacy.3x,v 1.12 2020/10/18 00:16:04 tom Exp $
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
@@ -37,23 +38,23 @@ curs_legacy \- get \fBcurses\fP cursor and window coordinates, attributes
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .sp
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .sp
-\fBint getattrs(WINDOW *win);\fP
-.br
-\fBint getbegx(WINDOW *win);\fP
-.br
-\fBint getbegy(WINDOW *win);\fP
-.br
-\fBint getcurx(WINDOW *win);\fP
-.br
-\fBint getcury(WINDOW *win);\fP
+\fBint getattrs(const WINDOW *\fP\fIwin\fP\fB);\fP
+.sp
+\fBint getbegx(const WINDOW *\fP\fIwin\fP\fB);\fP
 .br
 .br
-\fBint getmaxx(WINDOW *win);\fP
+\fBint getbegy(const WINDOW *\fP\fIwin\fP\fB);\fP
+.sp
+\fBint getcurx(const WINDOW *\fP\fIwin\fP\fB);\fP
 .br
 .br
-\fBint getmaxy(WINDOW *win);\fP
+\fBint getcury(const WINDOW *\fP\fIwin\fP\fB);\fP
+.sp
+\fBint getmaxx(const WINDOW *\fP\fIwin\fP\fB);\fP
 .br
 .br
-\fBint getparx(WINDOW *win);\fP
+\fBint getmaxy(const WINDOW *\fP\fIwin\fP\fB);\fP
+.sp
+\fBint getparx(const WINDOW *\fP\fIwin\fP\fB);\fP
 .br
 .br
-\fBint getpary(WINDOW *win);\fP
+\fBint getpary(const WINDOW *\fP\fIwin\fP\fB);\fP
 .br
 .SH DESCRIPTION
 These legacy functions are simpler to use than the X/Open Curses functions:
 .br
 .SH DESCRIPTION
 These legacy functions are simpler to use than the X/Open Curses functions:
@@ -85,7 +86,7 @@ data as \fBgetparyx\fP.
 .SH RETURN VALUE
 Except as noted,
 these functions return an integer,
 .SH RETURN VALUE
 Except as noted,
 these functions return an integer,
-or ERR if the window parameter is null.
+or \fBERR\fP if the window parameter is null.
 .SH NOTES
 All of these interfaces are provided as macros and functions.
 The macros are suppressed (and only the functions provided)
 .SH NOTES
 All of these interfaces are provided as macros and functions.
 The macros are suppressed (and only the functions provided)