ncurses 5.9 - patch 20111217
[ncurses.git] / man / curs_add_wchstr.3x
index 17d3446985003225e8b4fc9f21f8ca2a118e81f2..957adc02572450c9a135c7e7041294ba6489295f 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2002 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 2002-2005,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_add_wchstr.3x,v 1.1 2002/02/23 22:15:55 tom Exp $
+.\" $Id: curs_add_wchstr.3x,v 1.9 2010/12/04 18:36:44 tom Exp $
 .TH curs_add_wchstr 3X ""
 .SH NAME
-.PP
 \fBadd_wchstr\fR,
 \fBadd_wchnstr\fR,
 \fBwadd_wchstr\fR,
@@ -40,7 +39,7 @@
 \fBmvwadd_wchnstr\fR \- add an array of complex characters (and attributes) to a curses window
 .SH SYNOPSIS
 .B #include <curses.h>
-
+.PP
 .nf
 \fBint add_wchstr(const cchar_t *\fR\fIwchstr\fR\fB);\fR
 .br
@@ -63,7 +62,7 @@ These routines copy the array of complex characters \fIwchstr\fR
 into the window image structure at and after the current cursor position.
 The four routines with \fIn\fR as the last
 argument copy at most \fIn\fR elements, but no more than will fit on the line.
-If \fBn\fR=\fB-1\fR then the whole array is copied,
+If \fBn\fR=\fB\-1\fR then the whole array is copied,
 to the maximum number of characters that will fit on the line.
 .PP
 The window cursor is \fInot\fR advanced.
@@ -73,7 +72,7 @@ On the other hand, they do not perform checking
 they do not advance the current cursor position,
 they do not expand other control characters to ^-escapes,
 and they truncate the string if it crosses the right margin,
-rather then wrapping it around to the new line.
+rather than wrapping it around to the new line.
 .PP
 These routines end successfully
 on encountering a null \fIcchar_t\fR, or
@@ -84,15 +83,13 @@ the remaining columns are filled with the background character and rendition.
 All functions except \fBwadd_wchnstr\fR may be macros.
 .SH RETURN VALUES
 All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success.
+.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 PORTABILITY
 All these entry points are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
 \fBcurses\fR(3X),
-\fBcurs_addchstr\fR(3X)
+\fBcurs_addchstr\fR(3X),
 \fBcurs_addwstr\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: