HP-UX Reference (11i v1 05/09) - 3 Library Functions A-M (vol 6)

innwstr(3X) innwstr(3X)

(ENHANCED CURSES)

NAME

innwstr, inwstr, mvinnwstr, mvinwstr, mvwinnwstr, mvwinwstr, winnwstr, winwstr — input a string of

wide characters from a window

SYNOPSIS

#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 speciﬁed window into the array

pointed to by wstr starting at the current or speciﬁed 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 char-

acter. If the array is large enough to contain at least one complete spacing complex character, the array is

ﬁlled with complete characters. If the array is not large enough to contain any complete characters this is

an error.

The innwstr(), mvinnwstr(), mvwinnwstr() and winnwstr() functions store at most n char-

acters in the array pointed to by wstr.

RETURN VALUE

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

Upon successful completion, innwstr(), mvinnwstr() , mvwinnwstr() and winnwstr() return

the number of characters actually read into the string.

Otherwise, all these functions return ERR.

ERRORS

No errors are deﬁned.

APPLICATION USAGE

Reading a line that overﬂows the array pointed to by wstr with inwstr(), mvinwstr()

mvwinwstr() or winwstr() causes undeﬁned results. The use of innwstr() , mvinnwstr() ,

mvwinnwstr() or winnwstr(), respectively, is recommended.

These functions do not return rendition information.