名称

form_field_info - フィールド特性を取り出す

書式

#include <form.h> int field_info(const FIELD *field, int *rows, int *cols,
int *frow, int *fcol, int *nrow, int *nbuf); int dynamic_field_info(const FIELD *field, int *rows, int *cols, int *max);

解説

関数 field_info は、その生成時にフィールドへ渡されたサイズ、および他の属性を返します。属性は、高さ、幅、上左の角の行、上左の角の列、画面外の列数および作業バッファの番号です。

関数 dynamic_field_info は、フィールドの実際のサイズおよびその可能な最大サイズを返します。フィールドにサイズ制限がない場合、3 つ目の引数のアドレス位置は、0 にセットされるでしょう。フィールドは、 field_opts_off での O_STATIC オプションをオフにすることによって動的に行うことができます。

戻り値

これらルーチンは次の 1 つを返します:

E_OK

ルーチンが成功した。

E_SYSTEM_ERROR

システムエラーが生じた ( errno 参照)。

E_BAD_ARGUMENT

ルーチンは正しくないか範囲外の引数を検知しました。

関連項目

エントリポイントの詳細な説明のための "form_"で始まる名前は curses(3X) と関連するページ。 (訳注: curses(3X) は存在しません。ncurses(3) 参照)

注

ヘッダファイル <form.h> は、自動的にヘッダファイル <curses.h> を含んでいます。

移植性

これらのルーチンは、System V メニューライブラリをエミュレートします。それらは、Version 7 または BSD バージョンではサポートされませんでした。

NULL (0 ポインタ) はその値を無視するために任意の戻り値を受け付けます。すべての実装はこれを許可するとは限りません、例えば、Solaris 2.7 はしません。

作者

Juergen Pfeifer。マニュアルページと新しい curses の適応は、Eric S. Raymond。