ncurses 6.1 - patch 20190209
[ncurses.git] / man / curs_ins_wstr.3x
index 197f30f5cd7d420a41ae679305ac86fa2d9f1331..5e11bae59b6571ef60800487272152867a6fbde4 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2002 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 2002-2012,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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_ins_wstr.3x,v 1.2 2002/03/10 23:43:27 tom Exp $
+.\" $Id: curs_ins_wstr.3x,v 1.8 2017/11/21 00:53:44 tom Exp $
 .TH curs_ins_wstr 3X ""
+.na
+.hy 0
 .SH NAME
 \fBins_wstr\fR,
 \fBins_nwstr\fR,
 \fBmvins_nwstr\fR,
 \fBmvwins_wstr\fR,
 \fBmvwins_nwstr\fR \- insert a wide-character string into a curses window
+.ad
+.hy
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>\fR
-
+.sp
 \fBint ins_wstr(const wchar_t *\fR\fIwstr);\fR
 .br
 \fBint ins_nwstr(const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
@@ -69,7 +73,7 @@ The cursor position does not change
 The four routines with \fIn\fR as the last argument
 insert a leading substring of at most \fIn\fR \fBwchar_t\fR characters.
 If \fIn\fR is less than 1, the entire string is inserted.
-
+.PP
 If a character in \fIwstr\fR is a tab, newline, carriage return or
 backspace, the cursor is moved appropriately within the window.
 A newline also does a \fBclrtoeol\fR before moving.
@@ -83,22 +87,20 @@ but instead returns a character in the ^-representation
 of the control character.
 .SH NOTES
 Note that all but wins_nwstr may be macros.
-
+.PP
 If the first character in the string is a nonspacing character, these
 functions will fail.
 XSI does not define what will happen if a nonspacing character follows
 a control character.
-.SH RETURN VALUES
-Upon successful completion, these functions return OK.
-Otherwise, they return ERR.
+.SH RETURN VALUE
+Upon successful completion, these functions return \fBOK\fP.
+Otherwise, they return \fBERR\fP.
+.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_insstr\fR(3X),
 \fBcurs_in_wch\fR(3X),
 \fBcurs_ins_wch\fR(3X).
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: