Content-type: text/html Man page of curs_inswstr

curs_inswstr

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

NAME

curs_inswstr, inswstr, insnwstr, winswstr, winsnwstr, mvinswstr, mvinsnwstr, mvwinswstr, mvwinsnwstr - Insert a wchar_t string before the character under the cursor in a Curses window  

SYNOPSIS

#include <curses.h>

int inswstr( wchar_t *wstr ); int insnwstr( wchar_t *wstr, int n ); int winswstr( WINDOW *win, wchar_t *wstr ); int winsnwstr( WINDOW *win, wchar_t *wstr, int n ); int mvinswstr( int y, int x, wchar_t *wstr ); int mvinsnwstr( int y, int x, wchar_t *wstr, int n ); int mvwinswstr( WINDOW *win, int y, int x, wchar_t *wstr ); int mvwinsnwstr( WINDOW *win, int y, int x, wchar_t *wstr, int n );
 

LIBRARY

Curses Library (libcurses)
 

DESCRIPTION

These routines insert a wchar_t character string (as many wchar_t characters as will fit on the line) before the character under the cursor. All characters to the right of the cursor are moved to the right, with the possibility of the rightmost characters on the line being lost. The routines do not change the cursor position after moving to y, x, if specified. (This does not imply use of the hardware insert character feature.)

The four routines with n as the last argument insert at most n wchar_t characters. If n<=0, then the routines insert the entire string.

If a character in wstr is a tab, newline, carriage return, or backspace, the cursor is moved appropriately within the window. A newline also results in clrtoeol before moving. Tabs are considered to be at every eighth column. If a character in wstr is another control character, it is drawn in the ^X notation. Calling winch after adding a control character (and moving to it, if necessary) does not return the control character, but instead returns the representation of the control character.
 

NOTES

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

Note that all but winsnwstr 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. Compaq recommends the use of the *ins_wstr and *ins_nwstr functions in new applications (see curs_ins_wstr(3)).
 

RETURN VALUES

All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion.
 

SEE ALSO

Functions: curses(3), curs_clear(3), curs_ins_wstr(3), curs_inwch(3)


 

Index

NAME
SYNOPSIS
LIBRARY
DESCRIPTION
NOTES
RETURN VALUES
SEE ALSO

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