ncurses 6.0 - patch 20150822

[ncurses.git] / man / curs_get_wch.3x

diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index 6ecff799b5d60a96987e06b408a359d236b25098..df9bc6a6e6c6541311cfdeafe9d2321090abb7ca 100644 (file)
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 2002-2003,2006 Free Software Foundation, Inc.              *
+.\" Copyright (c) 2002-2010,2012 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 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_get_wch.3x,v 1.6 2006/02/25 21:47:06 tom Exp $
+.\" $Id: curs_get_wch.3x,v 1.8 2012/11/03 23:03:59 tom Exp $

 .TH curs_get_wch 3X ""
 .SH NAME
 \fBget_wch\fR,
 .TH curs_get_wch 3X ""
 .SH NAME
 \fBget_wch\fR,


@@ -132,7 +132,7 @@ is typed, the program may produce undesirable results.
 .PP
 All functions except \fBwget_wch\fR and \fBunget_wch\fR
 may be macros.
 .PP
 All functions except \fBwget_wch\fR and \fBunget_wch\fR
 may be macros.

-.SH RETURN VALUES
+.SH RETURN VALUE

 When
 \fBget_wch\fR,
 \fBwget_wch\fR,
 When
 \fBget_wch\fR,
 \fBwget_wch\fR,


@@ -152,6 +152,10 @@ returns
 \fBOK\fR.
 Otherwise, the function returns
 \fBERR\fR.
 \fBOK\fR.
 Otherwise, the function returns
 \fBERR\fR.

+.PP
+Functions with a "mv" prefix first perform a cursor movement using
+\fBwmove\fP, and return an error if the position is outside the window,
+or if the window pointer is null.

 .SH SEE ALSO
 \fBcurses\fR(3X),
 \fBcurs_getch\fR(3X),
 .SH SEE ALSO
 \fBcurses\fR(3X),
 \fBcurs_getch\fR(3X),