curs_getcchar(3X) | curs_getcchar(3X) |
名称
getcchar, setcchar - cchar_t からワイド文字列と表現 (rendition) を取得するか、またはワイド文字列から cchar_t を設定します書式
#include <curses.h>解説
getcchar 関数は、 cchar_t 引数からワイド文字列と表現 (rendition) を取得します。 wch が null ポインタでないときに、 getcchar 関数は次を行います:
- -
- cchar_t 値の wcval から情報を抽出します。
- -
- attrs によって指される位置に文字属性を格納します。
- -
- color_pair によって指される位置にカラーペア (組) を格納します。
- -
- ワイド文字列、 wcval によって参照される文字を、 wch によって指される配列に格納します。
wch が null ポインタであるときに、 getcchar 関数は次を行います:
- -
- wcval によって指されたワイド文字のの数を取得します。
- -
- attrs または color_pair によって参照されるデータを変更しません。
setcchar 関数は、次を使用することによって wcval によって指された位置を初期化します。
- -
- attrs の文字属性。
- -
- color_pair のカラーペア (組)。
- -
- wch によって指されたワイド文字列。文字列は、L'\0' で終了し、最初に、多くても 1 つの空白類文字を含んでいなければなりません。
- 最大 CCHARW_MAX-1 文字の空白でない文字が続きます。追加の空白でない文字は、無視されます。
- 文字列は、代わりに単一制御文字を含むことができます。その場合、空白でない文字は、許可されません。
注
opts 引数は、今後の使用のために予約されています。現在、アプリケーションは、 opts として null ポインタを提供しなければなりません。wcval 引数は、 setcchar への呼び出しか、 cchar_t 出力引数がある関数によって生成された値を指定できます。 wcval が任意の他の手段によって組み立てられるなら、結果は不定です。
戻り値
wch が null ポインタであるときに、 getcchar は wcval によって参照されたワイド文字の数を返します。wch が null ポインタでないときに、 getcchar は成功して終了すれば OK を、そうでなければ ERR を返します。
成功して終了すれば、 setcchar は OK を返します。そうでなければ、 ERR を返します。