innwstr(3curses)

innwstr -- input a string of wide characters from a window

Synopsis

cc [options] file -lcurses

#include <curses.h>

int innwstr(wchar_t *wstr, int n);

int inwstr(wchar_t *wstr);

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

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

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

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

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

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

Description

These functions place a string of wchar_t characters from the current or specified window into the array pointed to by wstr starting at the current or specified cursor position and ending at the end of the line.

These functions will only store the entire wide character sequence associated with a spacing complex character. If the array is large enough to contain at least one complete spacing complex character, the array is filled with complete characters. If the array is not large enough to contain any complete characters this is an error.

The innwstr(3curses), mvinnwstr(3curses), mvwinnwstr(3curses) and winnwstr(3curses) functions store at most n characters in the array pointed to by wstr.

Return value

Upon successful completion, inwstr(3curses), mvinwstr(3curses), mvwinwstr(3curses) and winwstr(3curses) return OK.

Upon successful completion, innwstr(3curses), mvinnwstr(3curses), mvwinnwstr(3curses) and winnwstr(3curses) return the number of characters actually read into the string.

Otherwise, all these functions return ERR.

Errors

No errors are defined.

Usage

Reading a line that overflows the array pointed to by wstr with inwstr(3curses), mvinwstr(3curses), mvwinwstr(3curses) or winwstr(3curses) causes undefined results. The use of innwstr(3curses), mvinnwstr(3curses), mvwinnwstr(3curses) or winnwstr(3curses), respectively, is recommended.

These functions do not return rendition information.

Standards Conformance

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

References

curses(4)