ncurses 5.7 - patch 20101002
[ncurses.git] / man / curs_in_wch.3x
index 668595c6f3ed2bd2f75447229b924183ed3f656d..6b3e53efca1b7d774144e171d977bbbf1c49427c 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2002 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 2002-2006,2010 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_in_wch.3x,v 1.1 2002/03/10 15:08:57 tom Exp $
+.\" $Id: curs_in_wch.3x,v 1.4 2010/08/14 23:29:16 tom Exp $
 .TH curs_in_wch 3X ""
 .SH NAME
 \fBin_wch\fR,
 \fBmvin_wch\fR,
 \fBmvwin_wch\fR,
-\fBwin_wch\fR - extract a complex character and rendition from a window
+\fBwin_wch\fR \- extract a complex character and rendition from a window
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBint in_wch(cchar_t *\fR\fIwcval\fR\fB);\fR
 .br
 \fBint mvin_wch(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
@@ -53,6 +53,10 @@ This implementation checks for null pointers, returns ERR in that case.
 Also, the \fImv\fR routines check for error moving the cursor, returning ERR
 in that case.
 Otherwise they return OK
+.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 NOTES
 Note that all of these routines may be macros.
 .SH PORTABILITY