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_instr(3CURSES)


NAME

 curs_instr, instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwinstr, mvwinnstr - get a string of characters from a curses window

SYNOPSIS

 
cc [ flag ... ] file ... -lcurses [ library ... ]
#include <curses.h>
int instr(char *str);
 int innstr(char *str, int n);
 int winstr(WINDOW *win, char *str);
 int winnstr(WINDOW *win, char *str, int n);
 int mvinstr(int y, int x, char *str);
 int mvinnstr(int y, int x, char *str, int n);
 int mvwinstr(WINDOW *win, int y, int x, char *str);
 int mvwinnstr(WINDOW *win, int y, int x, char *str, int n);

DESCRIPTION

 

These routines return a string of characters in str, starting at the current cursor position in the named window and ending at the right margin of the window. Attributes are stripped from the characters. The four functions with n as the last argument return the string at most n characters long.

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

 

curses(3CURSES), attributes(5)

NOTES

 

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

Note that all routines except winnstr() 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.