GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
curs_in_wchstr(3X) Library calls curs_in_wchstr(3X)

in_wchstr, in_wchnstr, win_wchstr, win_wchnstr, mvin_wchstr, mvin_wchnstr, mvwin_wchstr, mvwin_wchnstr - get a curses complex character string from a window

#include <ncurses/curses.h>
int in_wchstr(cchar_t *wchstr);
int win_wchstr(WINDOW *win, cchar_t *wchstr);
int mvin_wchstr(int y, int x, cchar_t *wchstr);
int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);
int in_wchnstr(cchar_t *wchstr, int n);
int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);

These functions return an array of complex characters in wchstr, starting at the current cursor position in the named window. Attributes (rendition) are stored with the characters.

The four functions with n as the last argument return a leading substring at most n characters long (exclusive of the trailing zeroed cchar_t. Transfer stops at the end of the current line, or when n characters have been stored at the location referenced by wchstr.

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 wchstr [see getcchar(3X)].

Upon successful completion, these functions return OK. Otherwise, they return ERR.

X/Open Curses defines no error conditions. This implementation returns an error

  • if the win parameter is null or
  • if the wchstr parameter is null.

Functions prefixed with “mv” first perform cursor movement and fail if the position (y, x) is outside the window boundaries.

All routines except win_wchnstr may be macros.

Reading a line that overflows the array pointed to by wchstr with in_wchstr, mvin_wchstr, mvwin_wchstr or win_wchstr causes undefined results. Therefore, the use of in_wchnstr, mvin_wchnstr, mvwin_wchnstr, or win_wchnstr is recommended.

X/Open Curses defines no error conditions. This implementation checks for null pointers, returning ERR in that case.

curs_inchstr(3X) describes comparable functions of the ncurses library in its non-wide-character configuration.

curses(3X), curs_inwstr(3X), curs_in_wch(3X)

2024-04-20 ncurses 6.5

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.