curs_instr(3x) curs_instr(3x)
instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwin-
str, mvwinnstr - get a string of characters from a curses
window
- 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);
These routines return a string of characters in str,
extracted starting at the current cursor position in the
named window. Attributes are stripped from the charac-
ters. The four functions with n as the last argument
return a leading substring at most n characters long
(exclusive of the trailing NUL).
これらのルーチンは、指定されたウインドウのカーソルの
現在位置から始まる文字列を取り出し、str の中に与えます。
属性は文字から切り捨てられます。
最後の引数に n を取る 4 つの関数は、(終端ヌル NUL を除いて)
先頭から最大 n 文字長の部分文字列を与えます。
訳注: mv で始まるルーチンは移動後のカーソル位置から始めて、
と思われます。
All of the functions return ERR upon failure, or the num-
ber of characters actually read into the string.
すべての関数は失敗のとき ERR を、または (正常ならば) 実際に
文字列へ読み込んだ文字数を返します。
X/Open defines no error conditions. In this implementa-
tion, if the window parameter is null or the str parameter
is null, a zero is returned.
X/Open はエラーの条件を何も定義していません。
この実装では、ウインドウ引数がヌルのとき、または引数 str が
ヌルのとき、ゼロを返します。
Functions with a "mv" prefix first perform a cursor move-
ment using wmove, and return an error if the position is
outside the window, or if the window pointer is null.
mv で始まる関数は、最初に wmove を使用してカーソルを移動し、
位置がウインドウの外だった場合、またはウインドウ・ポインタが
ヌルの場合にエラーを返します。
Note that all routines except winnstr may be macros.
winnstr 以外のすべてのルーチンはマクロであるかもしれない
ことに注意してください。
SVr4 does not document whether a length limit includes or
excludes the trailing NUL.
SVr4 は長さの制限値に終端ヌル NUL を含めるかどうかを
明記していません。
The ncurses library extends the XSI description by allow-
ing a negative value for n. In this case, the functions
return the string ending at the right margin.
ncurses ライブラリは n の負の値を許すように XSI の記述を
拡張しています。
この場合、関数は右マージンで終わる文字列を与えます。
訳注: X/Open Curses Issue 4, Version 2 は、これらの関数が
ウインドウからマルチバイト文字列を入力するとしています。
instr, mvinstr, mvwinstr, winstr は正常終了のとき OK を
返すとしています。
また、innstr, mvinnstr, mvwinnstr, winnstr は 1 つの文字に
関連するマルチバイト列の全体だけを読み込み、出力先の配列に
1 つの文字を完全に入れる大きさがないとき、これらの関数は
失敗するとしています。
curses(3x).
curs_instr(3x)