名称

inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr, mvwinchstr, mvwinchnstr - curses ウィンドウから文字列 (と属性) を取得する

書式

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

解説

これらのルーチンは、指定されたウィンドウ中の現在のカーソル位置から始まり、ウィンドウの右のマージンで終了する、 chtype 量の NULL で終了する配列を返します。最後の引数として n がある 4 つの関数は、 (後続する (chtype)0 を除外して) n 文字長の先導する部分文字列を返します。 <curses.h> に定義された定数は chstr の中の任意の位置から文字か属性を単独で抽出するために & (論理 AND) オペレータと共に使用できます [ curs_inch(3X) を参照]。

戻り値

整数を返すすべてのルーチンは、失敗すると ERR を返します。成功して終了すれば、 ERR 以外の (後続する 0 を除いて、取り出された文字の数の) 整数値を返します。

エラー条件は何も定義されていません。 chstr パラメータが null であるなら、データを返しません、そして、リターン値は 0 です。

注

winchnstr を除いてすべてのルーチンはマクロであるかもしれないことに注意してください。 SVr4 は、結果の文字列が 0 で終了するかどうか明記していません。それは、長さ制限の引数が後続する 0 を含むかどうかも文書化されていません。そして、戻り値の意味も文書化されていません。

移植性

これらの関数は、XSI Curses standard, Issue 4 に記述されています。後続する 0 について SVr4 文書は記述していません。成功した関数の戻りは OK であることは記述してあります。

関連項目

curses(3X), curs_inch(3X)

ワイド文字 (ncursesw) ライブラリの同等の関数は、 curs_in_wchstr(3X) に説明されています。