X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_addchstr.3x;h=ca285ada4151493c3844087517386705252e871f;hb=894a177fd5228cdbe790bd1dc9435bd435c29681;hp=44d1b79f35ca8ade44ab66ee625f6d752b837200;hpb=06078d3fa68db669ed37178c01873546b4b28745;p=ncurses.git diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x index 44d1b79f..ca285ada 100644 --- a/man/curs_addchstr.3x +++ b/man/curs_addchstr.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2012,2017 Free Software Foundation, Inc. * +.\" Copyright 2019-2022,2023 Thomas E. Dickey * +.\" Copyright 1998-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 * @@ -26,58 +27,60 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addchstr.3x,v 1.17 2017/11/18 23:56:00 tom Exp $ -.TH curs_addchstr 3X "" +.\" $Id: curs_addchstr.3x,v 1.34 2023/10/07 21:19:07 tom Exp $ +.TH curs_addchstr 3X 2023-10-07 "ncurses 6.4" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBaddchstr\fR, -\fBaddchnstr\fR, -\fBwaddchstr\fR, -\fBwaddchnstr\fR, -\fBmvaddchstr\fR, -\fBmvaddchnstr\fR, -\fBmvwaddchstr\fR, -\fBmvwaddchnstr\fR \- add a string of characters (and attributes) to a \fBcurses\fR window -.ad -.hy +\fB\%addchstr\fP, +\fB\%addchnstr\fP, +\fB\%waddchstr\fP, +\fB\%waddchnstr\fP, +\fB\%mvaddchstr\fP, +\fB\%mvaddchnstr\fP, +\fB\%mvwaddchstr\fP, +\fB\%mvwaddchnstr\fP \- +add a \fIcurses\fR character string to a window .SH SYNOPSIS .nf -\fB#include \fR +\fB#include .PP -\fBint addchstr(const chtype *chstr);\fR -.br -\fBint addchnstr(const chtype *chstr, int n);\fR -.br -\fBint waddchstr(WINDOW *win, const chtype *chstr);\fR -.br -\fBint waddchnstr(WINDOW *win, const chtype *chstr, int n);\fR -.br -\fBint mvaddchstr(int y, int x, const chtype *chstr);\fR -.br -\fBint mvaddchnstr(int y, int x, const chtype *chstr, int n);\fR -.br -\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 +\fBint addchstr(const chtype *\fIchstr\fP); +\fBint addchnstr(const chtype *\fIchstr\fP, int \fIn\fP); +\fBint waddchstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP); +\fBint waddchnstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP, int \fIn\fP); +.PP +\fBint mvaddchstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP); +\fBint mvaddchnstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\fP); +\fBint mvwaddchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP); +\fBint mvwaddchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\fP); .fi .SH DESCRIPTION These functions copy the (null-terminated) -\fIchstr\fR array +\fIchstr\fP 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, +The four functions with \fIn\fP as the last +argument copy at most \fIn\fP elements, but no more than will fit on the line. -If \fBn\fR=\fB\-1\fR then the whole array is copied, +If \fBn\fP=\fB\-1\fP 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. -These functions work faster than \fBwaddnstr\fR. +The window cursor is \fInot\fP advanced. +These functions work faster than \fBwaddnstr\fP. On the other hand: .bP they do not perform checking @@ -90,23 +93,23 @@ they do not expand other control characters to ^-escapes, and they truncate the string if it crosses the right margin, rather than wrapping it around to the new line. .SH RETURN VALUE -All functions return the integer \fBERR\fR upon failure and \fBOK\fR on success. +All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. .PP X/Open does not define any error conditions. This implementation returns an error if the window pointer is null. .PP -Functions with a "mv" prefix first perform a cursor movement using +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 -All functions except \fBwaddchnstr\fR may be macros. +All functions except \fBwaddchnstr\fP 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). +\fB\%curses\fP(3X), +\fB\%curs_addstr\fP(3X) .PP Comparable functions in the wide-character (ncursesw) library are described in -\fBcurs_add_wchstr\fR(3X). +\fB\%curs_add_wchstr\fP(3X).