Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
curs_addwstr(3X)		  Library calls 		curs_addwstr(3X)

NAME
     addwstr,  waddwstr, mvaddwstr, mvwaddwstr, addnwstr, waddnwstr, mvaddnwstr,
     mvwaddnwstr - add a wide-character string to a curses  window  and  advance
     the cursor

SYNOPSIS
     #include <curses.h>

     int addwstr(const wchar_t * wstr);
     int waddwstr(WINDOW * win, const wchar_t * wstr);
     int mvaddwstr(int y, int x, const wchar_t * wstr);
     int mvwaddwstr(WINDOW * win, int y, int x,
	   const wchar_t * wstr);

     int addnwstr(const wchar_t * wstr, int n);
     int waddnwstr(WINDOW * win, const wchar_t * wstr, int n);
     int mvaddnwstr(int y, int x, const wchar_t * wstr, int n);
     int mvwaddnwstr(WINDOW * win, int y, int x,
	   const wchar_t * wstr, int n);

DESCRIPTION
     waddwstr writes the characters of the (wide-null-terminated) wide-character
     string  wstr  to  the  window win, as if by constructing a cchar_t for each
     wchar_t in wstr, then calling  wadd_wch(3X)  with	the  resulting	cchar_t.
     curses  processes spacing and non-spacing characters in wstr one at a time.
     waddnwstr is similar, but writes at most n wide characters.  If  n  is  -1,
     waddnwstr	writes	the entire wide string.  ncurses(3X) describes the vari-
     ants of these functions.

RETURN VALUE
     These functions return OK on success and ERR on failure.

     In ncurses, these functions fail if

     *	 the curses screen has not been initialized,

     *	 wstr is a null pointer,

     *	 (for functions taking a WINDOW pointer argument) win is a null pointer,
	 or

     *	 an internal wadd_wch(3X) call returns ERR.

     Functions prefixed with "mv" first perform cursor movement and fail if  the
     position (y, x) is outside the window boundaries.

NOTES
     All of these functions except waddnwstr may be implemented as macros.

PORTABILITY
     X/Open Curses Issue 4 describes these functions.

     SVr4  describes  a  successful return value only as "an integer value other
     than ERR".

HISTORY
     X/Open Curses Issue 4 (1995) initially specified these functions.	The Sys-
     tem V Interface Definition Version 4 of the same year  specified  functions
     named  waddwstr  and  waddnwstr (and the usual variants).	These were later
     additions to SVr4.x, not appearing in the first SVr4 (1989).

SEE ALSO
     curs_addstr(3X) describes comparable functions of the  ncurses  library  in
     its non-wide-character configuration.

     curses(3X), curs_add_wch(3X), curs_add_wchstr(3X)

ncurses 6.6			   2025-03-15			curs_addwstr(3X)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=curs_addwstr&sektion=3&manpath=FreeBSD+15.1-RELEASE+and+Ports.quarterly>

home | help