man/man3curses/curs_getwstr.3curses

         te
 Copyright 1989 AT&T
 Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
 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.
 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.
 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]
 CURS_GETWSTR 3CURSES "Dec 31, 1996"
 NAME
curs_getwstr, getwstr, getnwstr, wgetwstr, wgetnwstr, mvgetwstr, mvgetnwstr,
mvwgetwstr, mvwgetnwstr - get wchar_t character strings from curses terminal
keyboard
 SYNOPSIS

cc [ flag ... ] file ... -lcurses [ library .. ]
#include <curses.h>

int getwstr(wchar_t *wstr);


int getnwstr(wchar_t *wstr, int n);


int wgetwstr(WINDOW *win, wchar_t *wstr);


int wgetnwstr(WINDOW *win, wchar_t *wstr, int n);


int mvgetwstr(int y, int x, wchar_t *wstr);


int mvgetnwstr(int y, int x, wchar_t *wstr, int n);


int mvwgetwstr(WINDOW *win, int y, int x, wchar_t *wstr);


int mvwgetnwstr(WINDOW *win, int y, int x, wchar_t *wstr, int n);


 DESCRIPTION

The effect of getwstr() is as though a series of calls to
getwch(3CURSES) were made, until a newline and carriage return is
received. The resulting value is placed in the area pointed to by the
wchar_t pointer wstr. getnwstr() reads at most n
wchar_t characters, thus preventing a possible overflow of the input
buffer. The user's erase and kill characters are interpreted, as well as any
special keys (such as function keys, HOME key, CLEAR key, etc.).
 RETURN VALUE

All routines return the integer ERR upon failure and an integer value
other than ERR upon successful completion.
 ATTRIBUTES

See attributes(5) for a description of the following attributes:


ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe


 SEE ALSO

curses(3CURSES), getwch(3CURSES), attributes(5)
 NOTES

The header file <curses.h> automatically includes the header files
<stdio.h>, <unctrl.h>, and <widec.h>.

Note that all routines except wgetnwstr() may be macros.