Content-type: text/html Man page of curs_instr

curs_instr

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

NAME

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

SYNOPSIS

#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 );
 

LIBRARY

Curses Library (libcurses)
 

STANDARDS

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

instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwinstr, mvwinnstr:  XPG4-UNIX

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

DESCRIPTION

These routines return the 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 a string that is at most n characters long.
 

NOTES

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

Note that all routines except winnstr may be macros.
 

RETURN VALUES

All routines return ERR upon failure. Upon successful completion, the *instr routines return OK, and the *innstr routines return the number of characters read into the string.
 

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:40:46 GMT, October 02, 2010