This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

curs_inwstr(3X)                                                                              curs_inwstr(3X)



NAME
       inwstr,  innwstr,  winwstr,  winnwstr,  mvinwstr,  mvinnwstr, mvwinwstr, mvwinnwstr - get a string of
       wchar_t characters from a curses window

SYNOPSIS
       #include <curses.h>

       int inwstr(wchar_t *str);
       int innwstr(wchar_t *str, int n);
       int winwstr(WINDOW *win, wchar_t *str);
       int winnwstr(WINDOW *win, wchar_t *str, int n);
       int mvinwstr(int y, int x, wchar_t *str);
       int mvinnwstr(int y, int x, wchar_t *str, int n);
       int mvwinwstr(WINDOW *win, int y, int x, wchar_t *str);
       int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *str, int n);

DESCRIPTION
       These routines return a string of wchar_t characters in wstr, extracted starting at the current  cur-sor cursor
       sor  position  in the named window.  Attributes are stripped from the characters.  The four functions
       with n as the last argument return a leading substring at most n bytes long (exclusive of the  trail-ing trailing
       ing  NUL).   Transfer  stops  at the end of the current line, or when n bytes have been stored at the
       location referenced by wstr.

       If the size n is not large enough to store a complete character, an error is generated.

NOTES
       Note that all routines except winnwstr may be macros.

RETURN VALUES
       All routines return ERR upon failure. Upon successful completion, the *inwstr routines return OK, and
       the *innwstr routines return the number of characters read into the string.

SEE ALSO
       Functions: curses(3X), curs_instr(3X), curs_in_wchstr(3X)



                                                                                             curs_inwstr(3X)