curs_addchstr(3X) | curs_addchstr(3X) |
名称
addchstr, addchnstr, waddchstr, waddchnstr, mvaddchstr, mvaddchnstr, mvwaddchstr, mvwaddchnstr - 文字列 (と属性) を curses ウィンドウに追加する書式
#include <curses.h>int addchstr(const chtype *chstr);
int addchnstr(const chtype *chstr, int n);
int waddchstr(WINDOW *win, const chtype *chstr);
int waddchnstr(WINDOW *win, const chtype *chstr, int n);
int mvaddchstr(int y, int x, const chtype *chstr);
int mvaddchnstr(int y, int x, const chtype *chstr, int n);
int mvwaddchstr(WINDOW *win, int y, int x, const chtype *chstr);
int mvwaddchnstr(WINDOW *win, int y, int x, const chtype *chstr, int n);
解説
これらのルーチンは、現在のカーソル位置の後に chstr をウィンドウイメージ構造にコピーします。最後の引数として n がある 4 つのルーチンは、多くても n 個の要素をコピーしますが、行に入る以上はコピーされません。 n= -1 であるなら、文字列全体が、行に入る最大の文字数までコピーされます。ウィンドウカーソルは、進め られず、これらのルーチンは、 waddnstr より速く動作します。いっぽう、(改行、バックスペースまたはキャリッジリターン文字のような) いかなる種類のチェックを実行せず、それらは、現在のカーソル位置を進めず、それらは、制御文字を ^-エスケープに拡張せず、そして、それらは、右のマージンと交差するなら、新しい行へ折り返すのではなく、文字列を切り詰めます。
戻り値
すべてのルーチンは、失敗すると整数 ERR を返し、そうでなければ前のルーチンで説明されている注記を除いて、成功して終了すれば、 OK (SVr4 マニュアルは、" ERR 以外の整数値"とだけ明記されています) を返します。X/Open は、エラー条件を何も定義していません。この実装は、ウィンドウのポインタが NULL であるなら、エラーを返します。
注
waddchnstr を除いて、すべてのルーチンは、マクロであるかもしれないことに注意してください。移植性
これらのエントリポイントは、XSI Curses standard, Issue 4 に記述されています。関連項目
curses(3X)ワイド文字 (ncursesw) ライブラリの同等の関数は、 curs_add_wchstr(3X) に説明されています。