curs_instr(3X)

名称

instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwinstr, mvwinnstr - curses ウィンドウから文字列を取得する

書式

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

これらのルーチンは、指定されたウィンドウの中で現在のカーソル位置から始まって抽出された、 str の中の一連の文字を返します、属性は文字から取り去られます。最後の引数として n がある 4 つの関数は、 (後続するヌル文字を除外して) 多くても n 文字長の先導する部分文字列を返します。

関数は、すべて失敗すれば ERR を返すか、文字列中に実際に読み込まれた文字の数を返します。

X/Open は、エラー条件を何も定義していません。この実装は、ウィンドウのポインタが null である、または str パラメータが null であるなら、0 が返されます。

winnstr を除いてすべてのルーチンはマクロであるかもしれないことに注意してください。

SVr4 は、長さの制限が後続するヌル文字を含んでいるか除外するかどうか文書化されていません。

ncurses ライブラリは n に対して負の値を許すことにより XSI 記述を拡張します。この場合、関数は右のマージンで終了する文字列を返します。