Content-type: text/html Man page of curs_addwchstr

curs_addwchstr

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

curs_addwchstr, addwchstr, addwchnstr, waddwchstr, waddwchnstr, mvaddwchstr, mvaddwchnstr, mvwaddwchstr, mvwaddwchnstr - Add a string of wchar_t characters (and attributes) to a Curses window  

SYNOPSIS

#include <curses.h>

int addwchstr( chtype *wchstr ); int addwchnstr( chtype *wchstr, int n ); int waddwchstr( WINDOW *win, chtype *wchstr ); int waddwchnstr( WINDOW *win, chtype *wchstr, int n ); int mvaddwchstr( int y, int x, chtype *wchstr ); int mvaddwchnstr( int y, int x, chtype *wchstr, int n ); int mvwaddwchstr( WINDOW *win, int y, int x, chtype *wchstr ); int mvwaddwchnstr( WINDOW *win, int y, int x, chtype *wchstr, int n );
 

LIBRARY

Curses Library (libcurses)
 

DESCRIPTION

All of these routines copy wchstr, which points to a string of wchar_t characters, directly into the window image structure starting at the current or specified 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 all the routines copy the whole string, to the maximum number that fit on the line or until a null terminator is reached.

The routines do not advance the position of the window cursor. They work faster than waddnwstr because they merely copy wchstr into the window image structure. On the other hand, care must be taken when using these functions because they: Do not perform any kind of checking (such as for the newline character) Do not advance the current cursor position Truncate the string, rather then wrapping it around to the new line
 

NOTES

The header file <curses.h> automatically includes the header file <stdio.h>.

Note that all routines except waddwchnstr may be macros.

The routines described on this reference page are among the MNLS Curses functions that are not included in the X/Open Curses CAE specification. MNLS routines are supported only for backward compatibility reasons. For new applications, Compaq recommends the use of the routines described on the add_wchstr(3) reference page.
 

RETURN VALUES

All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion, unless otherwise noted in the preceding routine descriptions.
 

SEE ALSO

Functions: curses(3), add_wchstr(3)


 

Index

NAME
SYNOPSIS
LIBRARY
DESCRIPTION
NOTES
RETURN VALUES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:41:30 GMT, October 02, 2010