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

FreeBSD Manual Pages

  
 
  

home | help
curs_add_wchstr(3X)					   curs_add_wchstr(3X)

NAME
       add_wchstr, add_wchnstr,	wadd_wchstr, wadd_wchnstr, mvadd_wchstr,
       mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr - add an array of complex
       characters (and attributes) to a	curses window

SYNOPSIS
       #include	<curses.h>

       int add_wchstr(const cchar_t *wchstr);
       int add_wchnstr(const cchar_t *wchstr, int n);
       int wadd_wchstr(WINDOW *	win, const cchar_t *wchstr);
       int wadd_wchnstr(WINDOW * win, const cchar_t *wchstr, int n);
       int mvadd_wchstr(int y, int x, const cchar_t *wchstr);
       int mvadd_wchnstr(int y,	int x, const cchar_t *wchstr, int n);
       int mvwadd_wchstr(WINDOW	*win, int y, int x, const cchar_t *wchstr);
       int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int	n);

DESCRIPTION
       These  functions	copy the (null-terminated) array of complex characters
       wchstr into the window image structure starting at the  current	cursor
       position.   The four functions with n as	the last argument copy at most
       n elements, but no more than will fit on	the line.  If  n=-1  then  the
       whole  array  is	 copied, to the	maximum	number of characters that will
       fit on the line.

       The window cursor is not	advanced.  These functions  work  faster  than
       waddnstr.  On the other hand:

       o   they	 do  not perform checking (such	as for the newline, backspace,
	   or carriage return characters),

       o   they	do not advance the current cursor position,

       o   they	do not expand other control characters to ^-escapes, and

       o   they	truncate the string if it crosses  the	right  margin,	rather
	   than	wrapping it around to the new line.

       These  functions	 end  successfully  on encountering a null cchar_t, or
       when they have filled the current line.	If a complex character	cannot
       completely  fit	at  the	end of the current line, the remaining columns
       are filled with the background character	and rendition.

RETURN VALUE
       All functions return the	integer	ERR upon failure and OK	on success.

       X/Open does not define any error	conditions.  This  implementation  re-
       turns an	error if the window pointer is null.

       Functions  with	a  "mv"	 prefix	 first perform a cursor	movement using
       wmove, and return an error if the position is outside the window, or if
       the window pointer is null.

NOTES
       All functions except wadd_wchnstr may be	macros.

PORTABILITY
       These entry points are described	in the XSI Curses standard, Issue 4.

SEE ALSO
       curs_addwstr(3X), curses(3X).

       Comparable  functions in	the narrow-character (ncurses) library are de-
       scribed in curs_addchstr(3X).

							   curs_add_wchstr(3X)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO

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

home | help