Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wadd_wchnstr(3) [osf1 man page]

curs_add_wchstr(3)					     Library Functions Manual						curs_add_wchstr(3)

NAME
curs_add_wchstr, add_wchstr, add_wchnstr, wadd_wchstr, wadd_wchnstr, mvadd_wchstr, mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr - Add an array of complex characters and rendition 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 ); LIBRARY
Curses Library (libcurses) STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: add_wchstr, wadd_wchstr, wadd_wchnstr, mvadd_wchstr, mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr: XCURSES4.2 Refer to the standards(5) reference page for more information about industry standards and associated tags. DESCRIPTION
All of these functions copy wchstr, which points to an array of complex characters, directly into the current or specified window image structure starting at the current cursor position or the position specified. 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 that fit on the line. The position of the window cursor is not advanced. These functions work faster than add_wstr because they merely copy wchstr into the win- dow image structure. On the other hand, care must be taken when using these functions because they do not perform any kind of checking for special characters (such as for the newline character), they do not advance the current cursor position, and they truncate characters rather then wrapping them to the new line. These functions end successfully on encountering a null cchar_t. These functions also end successfully when they fill the current line. If a character cannot completely fit at the end of the current line, those columns are filled with the background character and rendition. NOTES
The header file <curses.h> automatically includes the header file <stdio.h>. Note that all functions except wadd_wchnstr may be macros. RETURN VALUES
All functions return the integer OK upon successful completion. Otherwise, they return ERR. SEE ALSO
Functions: curses(3), curs_addwstr(3) Others: standards(5) curs_add_wchstr(3)

Check Out this Related Man Page

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 routines copy the array of complex characters wchstr into the window image structure at and after the current cursor position. The four routines 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 routines work faster than waddnstr. On the other hand, they do not perform checking (such as for the newline, backspace, or carriage return characters), they do not advance the current cursor position, they do not expand other control characters to ^-escapes, and they truncate the string if it crosses the right margin, rather then wrapping it around to the new line. These routines 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. NOTES
All functions except wadd_wchnstr may be macros. RETURN VALUES
All routines return the integer ERR upon failure and OK on success. PORTABILITY
All these entry points are described in the XSI Curses standard, Issue 4. SEE ALSO
curses(3X), curs_addchstr(3X) curs_addwstr(3X) curs_add_wchstr(3X)
Man Page