in_wchnstr(3curses)

in_wchnstr -- extract an array of complex characters and renditions from a window

Synopsis

cc [options] file -lcurses

#include <curses.h>

int in_wchnstr(cchar_t *wchstr, int n);

int in_wchstr(cchar_t *wchstr);

int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);

int mvin_wchstr(int y, int x, cchar_t *wchstr);

int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);

int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);

int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);

int win_wchstr(WINDOW *win, cchar_t *wchstr);

Description

These functions extract characters from the current or specified window, starting at the current or specified position and ending at the end of the line, and place them in the array pointed to by wchstr.

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

Return value

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

Errors

No errors are defined.

Usage

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

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

in_wch(3curses), curses(4)