in_wchstr



in_wchstr

NAME
SYNOPSIS
DESCRIPTION
NOTES
RETURN VALUE
PORTABILITY
SEE ALSO

NAME

in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr, mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr − get an array of complex characters and renditions from a curses window

SYNOPSIS

#include <ncurses/curses.h>

int in_wchstr(cchar_t *wchstr);
int in_wchnstr(cchar_t *
wchstr, int n);
int win_wchstr(WINDOW *
win, cchar_t *wchstr);
int win_wchnstr(WINDOW *
win, cchar_t *wchstr, int n);
int mvin_wchstr(int
y, int x, cchar_t *wchstr);
int mvin_wchnstr(int
y, int x, cchar_t *wchstr, int n);
int mvwin_wchstr(WINDOW *
win, int y, int x, cchar_t *wchstr);
int mvwin_wchnstr(WINDOW *
win, int y, int x, cchar_t *wchstr, int n);

DESCRIPTION

These functions return an array of complex characters in wchstr, starting at the current cursor position in the named window. Attributes (rendition) are stored with the characters.

The in_wchnstr, mvin_wchnstr, mvwin_wchnstr and win_wchnstr fill the array with at most n cchar_t elements.

NOTES

Note that all routines except win_wchnstr may be macros.

Reading a line that overflows the array pointed to by wchstr with in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined results. Therefore, the use of in_wchnstr, mvin_wchnstr, mvwin_wchnstr, or win_wchnstr is recommended.

RETURN VALUE

Upon successful completion, these functions return OK. Otherwise, they return ERR.

Functions with a "mv" prefix first perform a cursor movement using wmove, and return an error if the position is outside the window, or if the window pointer is null.

PORTABILITY

The XSI Curses defines no error conditions. This implementation checks for null pointers, returning ERR in that case.

SEE ALSO

Functions: ncurses(3NCURSES), in_wch(3NCURSES), instr(3NCURSES), inwstr(3NCURSES) inchstr(3NCURSES)




More Linux Commands

manpages/grepdiff.1.html
grepdiff(1) - show files modified by a diff containing a reg
For each file modified by a patch, if the patch hunk contains the REGEX then the files name is printed. The regular expression is treated as POSIX Basic Regular

manpages/gluLookAt.3gl.html
gluLookAt(3gl) - define a viewing transformation (Man Page)
gluLookAt creates a viewing matrix derived from an eye point, a reference point indicating the center of the scene, and an UP vector. The matrix maps the refere

manpages/fputwc_unlocked.3.html
fputwc_unlocked(3) - nonlocking stdio functions (Man Page)
Each of these functions has the same behavior as its counterpart without the _unlocked suffix, except that they do not use locking (they do not set locks themse

manpages/wgetscrreg.3ncurses.html
wgetscrreg(3ncurses) - curses window properties (Man Page)
This implementation provides functions which return properties set in the WINDOW structure, allowing it to be opaque if the symbol NCURSES_OPAQUE is defined: is

manpages/FcFontList.3.html
FcFontList(3) - List fonts (Library - Linux man page).......
Selects fonts matching p, creates patterns from those fonts containing only the objects in os and returns the set of unique such patterns. If config is NULL, th

manpages/rintl.3.html
rintl(3) - round to nearest integer - Linux manual page.....
The nearbyint(), nearbyintf(), and nearbyintl() functions round their argument to an integer value in floating-point format, using the current rounding directio

manpages/perlbot.1.html
perlbot(1) - Bag o' Object Tricks (the BOT) - Linux man page
For information on OO programming with Perl, please see perlootut and perlobj. (The above documents supersede the collection of tricks that was formerly here in

manpages/Tcl_ChannelSeekProc.3.html
Tcl_ChannelSeekProc(3) - procedures for creating and manipul
Tcl uses a two-layered channel architecture. It provides a generic upper layer to enable C and Tcl programs to perform input and output using the same APIs for

manpages/delay_output.3ncurses.html
delay_output(3ncurses) - miscellaneous curses utility routin
delay_output.3ncurses - The unctrl routine returns a character string which is a printable representation of the character c, ignoring attributes. Control chara

manpages/groff_www.7.html
groff_www(7) - groff macros for authoring web pages.........
This manual page describes the GNU -mwww macro package, which is part of the groff document formatting system. The manual page is very a basic guide, and the ht

manpages/glLightModelfv.3gl.html
glLightModelfv(3gl) - set the lighting model parameters.....
glLightModel sets the lighting model parameter. pname names a parameter and params gives the new value. There are three lighting model parameters: GL_LIGHT_MODE

manpages/keyctl_describe.3.html
keyctl_describe(3) - Describe a key - Linux manual page.....
keyctl_describe() describes the attributes of a key as a NUL-terminated string. The caller must have view permission on a key to be able to get a description of





We can't live, work or learn in freedom unless the software we use is free.