diff options
Diffstat (limited to 'man/curs_addchstr.3x')
| -rw-r--r-- | man/curs_addchstr.3x | 50 |
1 files changed, 32 insertions, 18 deletions
diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x index 1547219..08536e3 100644 --- a/man/curs_addchstr.3x +++ b/man/curs_addchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-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 * @@ -26,8 +26,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp $ +.\" $Id: curs_addchstr.3x,v 1.16 2012/11/03 22:54:43 tom Exp $ .TH curs_addchstr 3X "" +.de bP +.IP \(bu 4 +.. .na .hy 0 .SH NAME @@ -42,6 +45,7 @@ .ad .hy .SH SYNOPSIS +.nf \fB#include <curses.h>\fR .PP \fBint addchstr(const chtype *chstr);\fR @@ -59,24 +63,33 @@ \fBint mvwaddchstr(WINDOW *win, int y, int x, const chtype *chstr);\fR .br \fBint mvwaddchnstr(WINDOW *win, int y, int x, const chtype *chstr, int n);\fR +.fi .SH DESCRIPTION -These routines copy \fIchstr\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 string is copied, to the maximum number of -characters that will fit on the line. +These functions copy the (null-terminated) +\fIchstr\fR array +into the window image structure +starting at the current cursor position. +The four functions 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, +to the maximum number of characters that will fit on the line. .PP -The window cursor is \fInot\fR advanced, and these routines work faster than -\fBwaddnstr\fR. On the other hand, they do not perform any kind of checking -(such as for the newline, backspace, or carriage return characters), 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, +The window cursor is \fInot\fR advanced. +These functions work faster than \fBwaddnstr\fR. +On the other hand: +.bP +they do not perform checking +(such as for the newline, backspace, or carriage return characters), +.bP +they do not advance the current cursor position, +.bP +they do not expand other control characters to ^-escapes, and +.bP +they truncate the string if it crosses the right margin, rather than wrapping it around to the new line. -.SH RETURN VALUES -All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success -(the SVr4 manuals specify only "an integer value other than \fBERR\fR") upon -successful completion, unless otherwise noted in the preceding routine -descriptions. +.SH RETURN VALUE +All functions return the integer \fBERR\fR upon failure and \fBOK\fR on success. .PP X/Open does not define any error conditions. This implementation returns an error @@ -86,10 +99,11 @@ 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 routines except \fBwaddchnstr\fR may be macros. +All functions except \fBwaddchnstr\fR may be macros. .SH PORTABILITY These entry points are described in the XSI Curses standard, Issue 4. .SH SEE ALSO +\fBcurs_addstr\fR(3X), \fBcurses\fR(3X). .PP Comparable functions in the wide-character (ncursesw) library are |