usr/src/man/man3curses/curs_inchstr.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH CURS_INCHSTR 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_inchstr, inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr,
  10 mvwinchstr, mvwinchnstr \- get a string of characters (and attributes) from a
  11 curses window
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  16 #include <curses.h>
  17
  18 \fBint\fR \fBinchstr\fR(\fBchtype *\fR\fIchstr\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBinchnstr\fR(\fBchtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBwinchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype *\fR\fIchstr\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBint\fR \fBwinchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR);
  34 .fi
  35
  36 .LP
  37 .nf
  38 \fBint\fR \fBmvinchstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIchstr\fR);
  39 .fi
  40
  41 .LP
  42 .nf
  43 \fBint\fR \fBmvinchnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR);
  44 .fi
  45
  46 .LP
  47 .nf
  48 \fBint\fR \fBmvwinchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIchstr\fR);
  49 .fi
  50
  51 .LP
  52 .nf
  53 \fBint\fR \fBmvwinchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR);
  54 .fi
  55
  56 .SH DESCRIPTION
  57 .sp
  58 .LP
  59 With these routines, a string of type \fBchtype\fR, starting at the current
  60 cursor position in the named window and ending at the right margin of the
  61 window, is returned. The four functions with \fIn\fR as the last argument,
  62 return the string at most \fIn\fR characters long. Constants defined in
  63 <\fBcurses.h\fR> can be used with the \fB&\fR (logical AND) operator to extract
  64 the character or the attribute alone from any position in the \fIchstr\fR (see
  65 \fBcurs_inch\fR(3CURSES)).
  66 .SH RETURN VALUES
  67 .sp
  68 .LP
  69 All routines return the integer \fBERR\fR upon failure and an integer value
  70 other than \fBERR\fR upon successful completion.
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 MT-Level        Unsafe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBcurs_inch\fR(3CURSES), \fBcurses\fR(3CURSES), \fBattributes\fR(5)
  91 .SH NOTES
  92 .sp
  93 .LP
  94 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
  95 and <\fBunctrl.h\fR>.
  96 .sp
  97 .LP
  98 Note that all routines except \fBwinchnstr()\fR may be macros.