mvwinchnstr man page on MirBSD

Man page or keyword search:  
man Server   6113 pages
apropos Keyword Search (all sections)
Output format
MirBSD logo
[printable version]



curs_inchstr(3)	    UNIX Programmer's Manual	  curs_inchstr(3)

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

SYNOPSIS
     #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
     These routines return  a  NULL-terminated	array  of  chtype
     quantities,  starting  at the current cursor position in the
     named window and ending at the right margin of  the  window.
     The  four	functions  with	 n as the last argument, return a
     leading substring at most n characters  long  (exclusive  of
     the trailing (chtype)0). 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(3)].

RETURN VALUE
     All routines return the integer ERR upon failure and an  in-
     teger  value  other than ERR upon successful completion (the
     number of characters retrieved, exclusive	of  the	 trailing
     0).

     No error conditions are defined. If the chstr  parameter  is
     null, no data is returned, and the return value is zero.

NOTES
     Note that all routines except winchnstr may be macros.  SVr4
     does not document whether the result string is 0-terminated;
     it does not document whether a  length  limit  argument  in-
     cludes  any trailing 0; and it does not document the meaning
     of the return value.

PORTABILITY
     These functions are described in the  XSI	Curses	standard,
     Issue 4.  It is no more specific than the SVr4 documentation
     on the trailing 0.	 It does specify that the successful  re-
     turn of the functions is OK.

MirOS BSD #10-current	Printed 18.8.2011			1

curs_inchstr(3)	    UNIX Programmer's Manual	  curs_inchstr(3)

SEE ALSO
     curses(3), curs_inch(3).

MirOS BSD #10-current	Printed 18.8.2011			2

[top]

List of man pages available for MirBSD

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net