Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
Curses Library Functionscurs_inchstr(3CURSES)


NAME

 curs_inchstr, inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr, mvwinchstr, mvwinchnstr - get a string of characters (and attributes) from a curses window

SYNOPSIS

 
cc [ flag ... ] file ... -lcurses [ library ... ]
#include <curses.h>
int inchstr(chtype *chstr);
 int inchnstr(chtype *chstr, int n);
 int winchstr(WINDOW *win, chtype *chstr);
 int winchnstr(WINDOW *win, chtype *chstr, int n);
 int mvinchstr(int y, int x, chtype *chstr);
 int mvinchnstr(int y, int x, chtype *chstr, int n);
 int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);
 int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);

DESCRIPTION

 

With these routines, a string of type chtype, starting at the current cursor position in the named window and ending at the right margin of the window, is returned. The four functions with n as the last argument, return the string at most n characters long. Constants defined in <curses.h> can be used with the & (logical AND) operator to extract the character or the attribute alone from any position in the chstr (see curs_inch(3CURSES)).

RETURN VALUES

 

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

ATTRIBUTES

 

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelUnsafe

SEE ALSO

 

curs_inch(3CURSES), curses(3CURSES), attributes(5)

NOTES

 

The header <curses.h> automatically includes the headers <stdio.h> and <unctrl.h>.

Note that all routines except winchnstr() may be macros.


SunOS 5.9Go To TopLast Changed 31 Dec 1996

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.