curs_inwstr 3x

curs_inwstr(3x)                                         curs_inwstr(3x)




NAME 名前

       inwstr,  innwstr,  winwstr, winnwstr, mvinwstr, mvinnwstr,
       mvwinwstr, mvwinnwstr - get a string of wchar_t characters
       from a curses window
       - curses ウインドウから wchar_t 型のワイド文字列を取得する


SYNOPSIS 書式

       #include <curses.h>

       int inwstr(wchar_t *str);
       int innwstr(wchar_t *str, int n);
       int winwstr(WINDOW *win, wchar_t *str);
       int winnwstr(WINDOW *win, wchar_t *str, int n);
       int mvinwstr(int y, int x, wchar_t *str);
       int mvinnwstr(int y, int x, wchar_t *str, int n);
       int mvwinwstr(WINDOW *win, int y, int x, wchar_t *str);
       int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *str, int n);

       訳注: strwstr の誤りと思われます。


DESCRIPTION 説明

       These  routines  return  a string of wchar_t characters in
       wstr, extracted starting at the current cursor position in
       the  named window.  Attributes are stripped from the char-
       acters.  The four functions with n as  the  last  argument
       return a leading substring at most n bytes long (exclusive
       of the trailing NUL).  Transfer stops at the  end  of  the
       current  line,  or  when  n  bytes have been stored at the
       location referenced by wstr.
        これらのルーチンは、指定のウインドウのカーソルの現在位置から
       始まる wchar_t 型のワイド文字列を取り出し wstr の中に
       与えます。
        属性は文字から切り捨てられます。
        最後の引数に n を取る 4 つの関数は、 (終端ヌル NUL を除いて) 
       先頭から最大 n バイト長の部分文字列を与えます。
        転送は現在行の終わりか、または wstr の指す領域に n バイトを
       格納したところで停止します。
       
       訳注: n バイトではなく n 文字と思われます。

       If the size n is not large  enough  to  store  a  complete
       character, an error is generated.
        サイズ n が 1 文字を完全に格納できるだけ大きくなければ、
       エラーが発生します。


NOTES 注意

       Note that all routines except winnwstr may be macros.
        winnwstr 以外のすべてのルーチンはマクロであるかもしれない
       ことに注意してください。


RETURN VALUE 戻り値

       All routines return ERR upon failure. Upon successful com-
       pletion, the *inwstr routines return OK, and the  *innwstr
       routines  return  the  number  of characters read into the
       string.
        すべてのルーチンは失敗のとき ERR を返します。
        正常終了のとき、*inwstr ルーチンは OK を、
       *innwstr ルーチンは文字列中に読み込んだ文字数を返します。

       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 を使用してカーソルを移動し、
       位置がウインドウの外だった場合、またはウインドウ・ポインタが
       ヌルの場合にエラーを返します。


SEE ALSO 関連項目

       curses(3x), curs_instr(3x), curs_in_wchstr(3x)



                                                        curs_inwstr(3x)