diff options
Diffstat (limited to 'contrib/ncurses/man/curs_printw.3x')
-rw-r--r-- | contrib/ncurses/man/curs_printw.3x | 48 |
1 files changed, 31 insertions, 17 deletions
diff --git a/contrib/ncurses/man/curs_printw.3x b/contrib/ncurses/man/curs_printw.3x index 8ba9d17..7c1a41b 100644 --- a/contrib/ncurses/man/curs_printw.3x +++ b/contrib/ncurses/man/curs_printw.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2000 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2006 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,50 +26,64 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_printw.3x,v 1.11 2000/07/01 20:11:32 tom Exp $ +.\" $Id: curs_printw.3x,v 1.16 2006/02/25 21:49:19 tom Exp $ .TH curs_printw 3X "" +.na +.hy 0 .SH NAME \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR, \fBmvwprintw\fR, \fBvwprintw\fR, \fBvw_printw\fR - print formatted output in \fBcurses\fR windows +.ad +.hy .SH SYNOPSIS \fB#include <curses.h>\fR - -\fBint printw(char *fmt\fR [\fB, arg\fR] \fB...);\fR +.sp +\fBint printw(const char *fmt, ...);\fR .br -\fBint wprintw(WINDOW *win, char *fmt\fR [\fB, arg\fR] \fB...);\fR +\fBint wprintw(WINDOW *win, const char *fmt, ...);\fR .br -\fBint mvprintw(int y, int x, char *fmt\fR [\fB, arg\fR] \fB...);\fR +\fBint mvprintw(int y, int x, const char *fmt, ...);\fR .br -\fBint mvwprintw(WINDOW *win, int y, int x,\fR - \fBchar *fmt\fR [\fB, arg]\fR ...); - -\fB#include <varargs.h>\fR +\fBint mvwprintw(WINDOW *win, int y, int x, const char *fmt, ...);\fR .br -\fBint vwprintw(WINDOW *win, char *fmt, varglist);\fR +\fBint vwprintw(WINDOW *win, const char *fmt, va_list varglist);\fR .br -\fBint vw_printw(WINDOW *win, char *fmt, varglist);\fR +\fBint vw_printw(WINDOW *win, const char *fmt, va_list varglist);\fR .br .SH DESCRIPTION The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR routines are analogous to \fBprintf\fR [see \fBprintf\fR(3S)]. In effect, the string that would be output by \fBprintf\fR is output instead as though \fBwaddstr\fR were used on the given window. - -The \fBvwprintw\fR routine is analogous to \fBvprintf\fR [see -\fBprintf\fR(3S)] and performs a \fBwprintw\fR using a variable -argument list. The third argument is a \fBva_list\fR, a pointer to a -list of arguments, as defined in \fB<varargs.h>\fR. +.PP +The \fBvwprintw\fR and \fBwv_printw\fR routines are analogous +to \fBvprintf\fR [see \fBprintf\fR(3S)] +and perform a \fBwprintw\fR using a variable argument list. +The third argument is a \fBva_list\fR, a pointer to a +list of arguments, as defined in \fB<stdarg.h>\fR. .SH RETURN VALUE Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful completion. +.PP +X/Open defines no error conditions. +In this implementation, +an error may be returned if it cannot allocate enough memory for the +buffer used to format the results. +It will return an error if the window pointer is null. .SH PORTABILITY The XSI Curses standard, Issue 4 describes these functions. The function \fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function \fBvw_printw\fR using the \fB<stdarg.h>\fR interface. +The Single Unix Specification, Version 2 states that +\fBvw_printw\fR is preferred to \fBvwprintw\fR since the latter requires +including \fB<varargs.h>\fR, which +cannot be used in the same file as \fB<stdarg.h>\fR. +This implementation uses \fB<stdarg.h>\fR for both, because that header +is included in \fB<curses.h\fR>. .SH SEE ALSO \fBcurses\fR(3X), \fBprintf\fR(3S), \fBvprintf(3S)\fR .\"# |