curs_getcchar 3x

curs_getcchar(3x)                                     curs_getcchar(3x)

NAME 名前

       getcchar,  setcchar 
       - cchar_t 値からワイド文字列と表示様式を取得する、
       ワイド文字列から cchar_t 値をセットする

書式

       #include <curses.h>

       int getcchar(
               const cchar_t *wcval,
               wchar_t *wch,
               attr_t *attrs,
               short *color_pair,
               void *opts );

       int setcchar(
               cchar_t *wcval,
               const wchar_t *wch,
               const attr_t attrs,
               short color_pair,
               void *opts );

説明

getcchar

       　getcchar 関数は cchar_t 型引数からワイド文字列と表示様式を
       取得します。
       　wch がヌルポインタでない場合、 getcchar 関数は次の
       動作をします。

       o   cchar_t 値 wcval から情報を引き出す

       o   attrs の指す領域に文字の属性を格納する

       o   color_pair の指す領域に色のペアを格納する

       o   wch の指す配列に wcval から参照される文字である
           ワイド文字列を格納する

       　wch がヌルポインタの場合、 getcchar 関数は次の動作をします。

       o   wcval の指すワイド文字の数を取得する

       o   attrs や color_pair の指すデータは変化させない

setcchar

       　setcchar 関数は wcval の指す領域を以下を用いて初期化します。

       o   attrs にある文字属性

       o   color_pair にある色のペア

       o   wch の指すワイド文字列。文字列は L'\0' で終端され、
           多くとも 1 つのスペーシング文字を、あれば先頭に含む必要が
           あります。

           これに CCHARW_MAX-1 個までの非スペーシング文字を
           続けることができます。
           付加的な非スペーシング文字は無視されます。

           文字列は上記の代わりに単一の制御文字を含むことができます。
           その場合、非スペーシング文字を含むことは許されません。

注意

       　引数 opts は将来のために予約されています。
       　現在は、 opts としてヌルポインタを与えなければなりません。

       　引数 wcval は setcchar 呼び出しまたは cchar_t 型の
       出力引数を持つ関数で生成された値を指定できます。
       　他の方法で生成された wcval の場合、結果は不定です。

戻り値

       　getcchar は wch がヌルポインタの場合、 wcval から参照される
       ワイド文字の数を返します。終端のヌルも 1 つと数えます。

       　getcchar は wch がヌルポインタでない場合、
       正常終了のとき OK を、そうでないとき ERR を返します。

       　setcchar は正常終了の場合に OK を、そうでない場合に ERR を
       返します。