Content-type: text/html Man page of curs_addchstr

curs_addchstr

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

NAME

curs_addchstr, addchstr, addchnstr, waddchstr, waddchnstr, mvaddchstr, mvaddchnstr, mvwaddchstr, mvwaddchnstr - Add string of characters (and attributes) to a Curses window  

SYNOPSIS

#include <curses.h>

int addchstr( const chtype *chstr ); int addchnstr( const chtype *chstr, int n ); int waddchstr( WINDOW *win, const chtype *chstr ); int waddchnstr( WINDOW *win, const chtype *chstr, int n ); int mvaddchstr( int y, int x, const chtype *chstr ); int mvaddchnstr( int y, int x, const chtype *chstr, int n ); int mvwaddchstr( WINDOW *win, int y, int x, const chtype *chstr ); int mvwaddchnstr( WINDOW *win, int y, int x, const chtype *chstr, int n );
 

LIBRARY

Curses Library (libcurses)
 

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

addchstr, waddchstr, mvaddchstr, mvwaddchstr:  XPG4, XPG4-UNIX

addchnstr, waddchnstr, mvaddchnstr, mvwaddchnstr:  XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.
 

DESCRIPTION

All of these routines copy chstr 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, up 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 waddnstr because they merely copy chstr 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 a new line
 

NOTES

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

Note that all routines except waddchstr and waddchnstr may be macros.
 

RETURN VALUES

All routines return the integer ERR upon failure and OK upon successful completion.
 

SEE ALSO

Functions: curses(3)

Others: standards(5)


 

Index

NAME
SYNOPSIS
LIBRARY
STANDARDS
DESCRIPTION
NOTES
RETURN VALUES
SEE ALSO

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