Movatterモバイル変換

curs_in_wchstr(3x) — Linux manual page

curs_in_wchstr(3X)curs_in_wchstr(3X)

NAME        top

in_wchstr,in_wchnstr,win_wchstr,win_wchnstr,mvin_wchstr,mvin_wchnstr,mvwin_wchstr,mvwin_wchnstr- get an array of       complex characters and renditions from a curses window

SYNOPSIS        top

#include <curses.h>int in_wchstr(cchar_t *wchstr);int in_wchnstr(cchar_t *wchstr, intn);int win_wchstr(WINDOW *win, cchar_t *wchstr);int win_wchnstr(WINDOW *win, cchar_t *wchstr, intn);int mvin_wchstr(inty, intx, cchar_t *wchstr);int mvin_wchnstr(inty, intx, cchar_t *wchstr, intn);int mvwin_wchstr(WINDOW *win, inty, intx, cchar_t *wchstr);int mvwin_wchnstr(WINDOW *win, inty, intx, cchar_t *wchstr, intn);

DESCRIPTION        top

       These  functions  return an array of complex characters inwchstr,       starting at the current cursor position in the named window.   At‐       tributes (rendition) are stored with the characters.       Thein_wchnstr,mvin_wchnstr,mvwin_wchnstrandwin_wchnstrfill       the array with at mostncchar_telements.

NOTES        top

       Note that all routines exceptwin_wchnstrmay be macros.       Reading a line that overflows the array pointed to bywchstr  within_wchstr,mvin_wchstr,mvwin_wchstrorwin_wchstrcauses unde‐       fined results.  Therefore, the use  ofin_wchnstr,mvin_wchnstr,mvwin_wchnstr, orwin_wchnstris recommended.

RETURN VALUE        top

       Upon successful completion, these functions returnOK.  Otherwise,       they returnERR.       Functions with a “mv” prefix first perform a cursor movement usingwmove,  and return an error if the position is outside the window,       or if the window pointer is null.

PORTABILITY        top

       The XSI Curses defines no error conditions.   This  implementation       checks for null pointers, returningERRin that case.

SEE ALSO        top

       Functions:curses(3X),curs_in_wch(3X),curs_instr(3X),curs_inw‐str(3X)curs_inchstr(3X)

COLOPHON        top

       This page is part of thencurses (new curses)  project.   Informa‐       tion     about    the    project    can    be    found    at           ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have a       bug   report    for    this    manual    page,    send    it    to       bug-ncurses-request@gnu.org.   This  page  was  obtained  from the       project's   upstream   Git   mirror   of   the   CVS    repository       ⟨https://github.com/mirror/ncurses.git⟩  on  2025-08-11.  (At that       time, the date of the most recent commit that  was  found  in  the       repository   was  2023-03-12.)   If  you  discover  any  rendering       problems in this HTML version of the page, or you believe there is       a better or more up-to-date source  for  the  page,  or  you  have       corrections  or  improvements  to the information in this COLOPHON       (which isnot part of the original manual page), send  a  mail  to       man-pages@man7.orgcurs_in_wchstr(3X)

HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH.