usr/src/man/man3xcurses/addnstr.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 ADDNSTR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 addnstr, addstr, mvaddnstr, mvaddstr, mvwaddnstr, mvwaddstr, waddnstr, waddstr
   9 \- add a multi-byte character string (without rendition) 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 \fBaddnstr\fR(\fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBaddstr\fR(\fBconst char *\fR\fIstr\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBmvaddnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBmvaddstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBmvwaddnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBint\fR \fBmvwaddstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR);
  46 .fi
  47
  48 .LP
  49 .nf
  50 \fBint\fR \fBwaddstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst char *\fR\fIstr\fR);
  51 .fi
  52
  53 .LP
  54 .nf
  55 \fBint\fR \fBwaddnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBaddstr()\fR function writes a null-terminated string of multi-byte
  62 characters to the \fBstdscr\fR window at the current cursor position. The
  63 \fBwaddstr()\fR function performs an identical action, but writes the
  64 character to the window specified by \fIwin\fR.  The \fBmvaddstr()\fR and
  65 \fBmvwaddstr()\fR functions write the string to the  position indicated by the
  66 \fIx\fR (column) and \fIy\fR (row) parameters (the  former to the \fBstdscr\fR
  67 window; the latter to window \fIwin\fR).
  68 .sp
  69 .LP
  70 The \fBaddnstr()\fR, \fBwaddnstr()\fR, \fBmvaddnstr()\fR, and
  71 \fBmvwaddnstr()\fR functions are similar but write at most \fIn\fR characters
  72 to the window. If \fIn\fR is less than 0, the entire string is written.
  73 .sp
  74 .LP
  75 All of these functions advance the cursor after writing the string.
  76 .sp
  77 .LP
  78 These functions are functionally equivalent to calling the corresponding
  79 function from the \fBaddch\fR(3XCURSES) set of functions once for each
  80 character in  the string.  Refer to the \fBcurses\fR(3XCURSES) man page for a
  81 complete description of  special character handling and of the interaction
  82 between the window rendition (or background character and rendition) and the
  83 character written.
  84 .sp
  85 .LP
  86 Note that these functions differ from the \fBaddchstr()\fR set of functions in
  87 that the \fBaddchstr\fR(3XCURSES) functions copy the string as is (without
  88 combining each character with the window rendition or the background character
  89 and rendition.
  90 .SH PARAMETERS
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fIstr\fR\fR
  95 .ad
  96 .RS 7n
  97 Is a pointer to the character string that is to be written to the window.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fIn\fR\fR
 104 .ad
 105 .RS 7n
 106 Is the maximum number of characters to be copied from \fIstr\fR. If \fIn\fR is
 107 less than 0, the entire string is written or as much of it as fits on the line.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fIy\fR\fR
 114 .ad
 115 .RS 7n
 116 Is the y (row) coordinate of the starting position of \fIstr\fR in the window.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fIx\fR\fR
 123 .ad
 124 .RS 7n
 125 Is the x (column) coordinate of the starting position of \fIstr\fR in  the
 126 window.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fIwin\fR\fR
 133 .ad
 134 .RS 7n
 135 Is a pointer to the window in which the string is to be written.
 136 .RE
 137
 138 .SH RETURN VALUES
 139 .sp
 140 .LP
 141 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 142 .SH ERRORS
 143 .sp
 144 .LP
 145 None.
 146 .SH ATTRIBUTES
 147 .sp
 148 .LP
 149 See \fBattributes\fR(5) for descriptions of the following attributes:
 150 .sp
 151
 152 .sp
 153 .TS
 154 box;
 155 c | c
 156 l | l .
 157 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 158 _
 159 Interface Stability     Standard
 160 _
 161 MT-Level        Unsafe
 162 .TE
 163
 164 .SH SEE ALSO
 165 .sp
 166 .LP
 167 \fBaddch\fR(3XCURSES), \fBaddchstr\fR(3XCURSES), \fBcurses\fR(3XCURSES),
 168 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)