usr/src/man/man3xcurses/addchstr.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ADDCHSTR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 addchstr, addchnstr, mvaddchstr, mvaddchnstr, mvwaddchnstr, mvwaddchstr,
   9 waddchstr, waddchnstr \- copy a character string (with renditions) to a window
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBaddchstr\fR(\fBconst chtype *\fR\fIchstr\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBaddchnstr\fR(\fBconst chtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBmvaddchnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBmvaddchstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype *\fR\fIchstr\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBmvwaddchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBint\fR \fBmvwaddchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype *\fR\fIchstr\fR);
  46 .fi
  47
  48 .LP
  49 .nf
  50 \fBint\fR \fBwaddchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst chtype *\fR\fIchstr\fR);
  51 .fi
  52
  53 .LP
  54 .nf
  55 \fBint\fR \fBwaddchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst chtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBaddchstr()\fR function copies the \fBchtype\fR character string to the
  62 \fBstdscr\fR window at the current cursor position.  The \fBmvaddchstr()\fR and
  63 \fBmvwaddchstr()\fR functions copy the  character string to the starting
  64 position indicated by the \fIx\fR (column)  and \fIy\fR (row) parameters (the
  65 former to the \fBstdscr\fR window;  the latter to window \fIwin\fR).  The
  66 \fBwaddchstr()\fR is identical to \fBaddchstr()\fR, but writes  to the window
  67 specified by \fIwin\fR.
  68 .sp
  69 .LP
  70 The \fBaddchnstr()\fR, \fBwaddchnstr()\fR, \fBmvaddchnstr()\fR, and
  71 \fBmvwaddchnstr()\fR functions write \fIn\fR characters to the window,  or as
  72 many as will fit on the line. If \fIn\fR is less than 0, the entire string is
  73 written, or as much of it as  fits on the line.  The former two functions place
  74 the string at the current cursor position; the  latter two commands use the
  75 position specified by the \fIx\fR and \fIy\fR parameters.
  76 .sp
  77 .LP
  78 These functions differ from the \fBaddstr\fR(3XCURSES) set of functions in two
  79 important respects.  First, these functions do \fInot\fR advance the cursor
  80 after writing the string to the window. Second, the current window rendition is
  81 not combined with the character;  only the attributes that are already part of
  82 the \fBchtype\fR character  are used.
  83 .SH PARAMETERS
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fIchstr\fR\fR
  88 .ad
  89 .RS 9n
  90 Is a pointer to the \fBchtype\fR string to be copied to the window.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fIn\fR\fR
  97 .ad
  98 .RS 9n
  99 Is the maximum number of characters to be copied from \fIchstr\fR.   If \fIn\fR
 100 is less than 0, the entire string is written or as much of it as fits on the
 101 line.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fIy\fR\fR
 108 .ad
 109 .RS 9n
 110 Is the y (row) coordinate of the starting position of \fIchstr\fR in the
 111 window.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fIx\fR\fR
 118 .ad
 119 .RS 9n
 120 Is the x (column) coordinate of the starting position of \fIchstr\fR  in the
 121 window.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fIwin\fR\fR
 128 .ad
 129 .RS 9n
 130 Is a pointer to the window to which the string is to be copied.
 131 .RE
 132
 133 .SH RETURN VALUES
 134 .sp
 135 .LP
 136 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 137 .SH ERRORS
 138 .sp
 139 .LP
 140 None.
 141 .SH ATTRIBUTES
 142 .sp
 143 .LP
 144 See \fBattributes\fR(5) for descriptions of the following attributes:
 145 .sp
 146
 147 .sp
 148 .TS
 149 box;
 150 c | c
 151 l | l .
 152 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 153 _
 154 Interface Stability     Standard
 155 _
 156 MT-Level        Unsafe
 157 .TE
 158
 159 .SH SEE ALSO
 160 .sp
 161 .LP
 162 \fBaddch\fR(3XCURSES), \fBaddnstr\fR(3XCURSES), \fBattroff\fR(3XCURSES),
 163 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)