日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
SCANF(3) FreeBSD ライブラリ関数マニュアル SCANF(3)
名称
scanf, fscanf, sscanf, vscanf, vsscanf, vfscanf -- 入力書式の変換
ライブラリ
標準 C ライブラリ (libc, -lc)
書式
#include <stdio.h>
int
scanf(const char * restrict format, ...);
int
fscanf(FILE * restrict stream, const char * restrict format, ...);
int
sscanf(const char * restrict str, const char * restrict format, ...);
#include <stdarg.h>
int
vscanf(const char * restrict format, va_list ap);
int
vsscanf(const char * restrict str, const char * restrict format,
va_list ap);
int
vfscanf(FILE * restrict stream, const char * restrict format,
va_list ap);
解説
scanf() 関数ファミリは、以下に記述されるように format にしたがって入力を
スキャンします。この書式は、変換指示子を含んでいます。そのような変換の結
果は、もしあるなら、ポインタ引数を通して格納されます。scanf() 関数は、標
準入力ストリーム stdin から入力を読み込み、fscanf() は、ストリームポイン
タ stream から入力を読み込み、そして sscanf() は、str によって指される文
字列から入力を読み込みます。vfscanf() 関数は、vfprintf(3) に似て、ポイン
タの可変引数リスト (stdarg(3) を参照) を使用してストリームポインタ stream
から入力を読み込みます。vscanf() 関数は、標準入力から可変引数リストをス
キャンし、vsscanf() 関数は、文字列からそれをスキャンします。これらは、そ
れぞれ、vprintf() と vsprintf() 関数に似ています。それぞれ連続したポイン
タ引数は、それぞれ連続した変換指示子と適切に対応していなければなりません
(が、下記の * 変換を参照)。すべての変換は、% (パーセント記号) 文字によっ
て導入されます。format 文字列は、他の文字も含んでいます。format 文字列の
(空白、タブまたは改行のような) 空白類は、入力の何もないことを含んで、任意
の量の空白類と一致します。ほかのすべては、それ自体に一致します。入力文字
がそのような書式文字と一致しないとき、スキャンは、停止します。入力変換を
行うことができないときも、スキャンは、停止します (下記を参照)。
変換
変換を導入する % 文字に続いて、次のようないくつかのフラグ文字があります:
* 割り当てを抑制します。続く変換は、いつもの通りに起こりますが、ポ
インタは、使用されません。変換の結果は、単に捨てられます。
hh 変換は、dioux または n の 1 つであり、次のポインタは、(int では
なく) char へのポインタであることを示します。
h 変換は、dioux または n の 1 つであり、次のポインタは、(int では
なく) short int へのポインタであることを示します。
l (エル)
変換は、dioux または n の 1 つであり、次のポインタは、(int では
なく) long int へのポインタであるか、または変換は、a, e, f また
は g の 1 つであり、次のポインタは、(float ではなく) double への
ポインタであるか、または変換は、c, s または [ の 1 つであり、次
のポインタは、(char ではなく) wchar_t の配列へのポインタであるこ
とを示します。
ll (エルエル)
変換は、dioux または n の 1 つであり、次のポインタは、(int では
なく) long long int へのポインタであることを示します。
L 変換は、a, e, f または g の 1 つであり、次のポインタは、long
double. へのポインタであることを示します。
j 変換は、dioux または n の 1 つであり、次のポインタは、(int では
なく) intmax_t へのポインタであることを示します。
t 変換は、dioux または n の 1 つであり、次のポインタは、(int では
なく) ptrdiff_t へのポインタであることを示します。
z 変換は、dioux または n の 1 つであり、次のポインタは、(int では
なく) size_t へのポインタであることを示します。
q (推奨されません。) 変換は、dioux または n の 1 つであり、次のポ
インタは、(int ではなく) long long int へのポインタであることを
示します。
これらのフラグに加えて、% と変換の間に、10 進の整数として表現されるオプ
ションの最大のフィールド幅があります。幅が与えられないなら、(下記の 1 つ
を除いて) ``infinity'' (無限) のデフォルトが使用されます。そうでなけれ
ば、多くても、この多くのバイトは、変換の処理でスキャンされます。lc, ls と
l[ 変換の場合に、フィールド幅は、スキャンされるマルチバイト文字の最大数を
指定します。変換が始まる前に、ほとんどの変換は、空白類をスキップします。
この空白類は、フィールド幅に対してカウントされません。
次の変換が、利用可能です:
% リテラル `%' に一致します。すなわち、書式文字列内の ``%%'' は、単一
の入力 `%' 文字に一致します。変換は、行われず、割り当ては、起こりま
せん。
d オプションの符号付き 10 進の整数に一致します。次のポインタは、int
へのポインタでなければなりません。
i オプションの符号付き整数に一致します。次のポインタは、int へのポイ
ンタでなければなりません。整数は、`0x' または `0X' で始まるなら、16
進数で読み込まれ、`0' で始まるなら、8 進数で読み込まれ、そうでなけ
れば、10 進数で読み込まれます。基数 (進数) に対応している文字だけが
使用されます。
o 8 進数の整数に一致します。次のポインタは、unsigned int へのポインタ
でなければなりません。
u オプションの符号付き 10 進の整数に一致します。次のポインタは、
unsigned int へのポインタでなければなりません。
x, X オプションの符号付き 16 進数の整数に一致します。次のポインタは、
unsigned int へのポインタでなければなりません。
a, A, e, E, f, F, g, G
strtod(3) のスタイルの浮動小数点数に一致します。次のポインタは、(l
または L が指定されないなら) float へのポインタでなければなりませ
ん。
s 空白類でない文字のシーケンスに一致します。次のポインタは、char への
ポインタでなければならず、配列は、すべてのシーケンスと終端のヌル文
字を受け付けるために十分に大きくなければなりません。入力文字列は、
最初にいずれかが起こっても、空白類または最大のフィールド幅で停止し
ます。
l 修飾子が存在するなら、次のポインタは、入力が、mbrtowc(3) によって
変換の後に置かれる wchar_t へのポインタでなければなりません。
S ls と同じです。
c width (幅) カウント文字 (デフォルト 1) のシーケンスに一致します。次
のポインタは、char へのポインタでなければならず、すべての文字のため
に十分な空間がなければなりません (終端のヌルは、追加されません)。先
導する空白類の通常のスキップは、抑制されます。最初の空白類をスキッ
プするために、書式中に明示的な空白を使用します。
l 修飾子が存在しているなら、次のポインタは、入力が mbrtowc(3) に
よって変換の後に置かれる wchar_t へのポインタでなければなりません。
C lc と同じです。
[ 受け付けられた文字の指定されたセットから文字の空でないシーケンスと
一致します。次のポインタは、char へのポインタでなければならず、終端
のヌル文字を加えて、文字列のすべての文字ために十分な空間がなければ
なりません。先導する空白類の通常のスキップは、抑制されます。文字列
は、特別な集合 (または、それ以外の) 文字から構成されています。集合
は、開き角括弧 [ 文字と閉じ角括弧 ] 文字の間の文字によって定義され
ます。集合は、開き角括弧の後の最初の文字がサーカムフレックス ^ であ
るなら、それらの文字を除外します。集合内に閉じ角括弧を含めるために
は、開き角括弧またはサーカムフレックスの後の最初の文字にします。あ
らゆる他の位置は、集合を終らせます。ハイフン文字 - もまた特別です。
他の 2 つ文字の間に置かれるとき、それは、すべての途中の文字を集合に
追加します。ハイフンを含めるためには、最後の閉じ角括弧の前の最後の
文字にします。例えば、`[^]0-9-]' は、集合 ``閉じ角括弧、0 から 9 ま
でとハイフンを除いたすべて'' を意味します。文字列は、集合内でない
(または集合内にサーカムフレックスがある) か、またはフィールド幅が尽
きるとき、文字の出現で終わます。
l 修飾子が存在するなら、次のポインタは、入力が mbrtowc(3) によって
変換された後に置かれる、wchar_t へのポインタでなければなりません。
p (printf(3) の `%p' によって印刷 (表示) されるような) ポインタ値に一
致します。次のポインタは、void へのポインタでなければなりません。
n 何も予期されません。代わりに、ここまで入力から消費された文字の数
は、int へのポインタでなければならない、次のポインタを通して格納さ
れます。* フラグによって抑制できますが、これは、変換ではありませ
ん。
小数点文字は、プログラムのロケール (カテゴリ LC_NUMERIC) で定義されます。
後方互換性のために、`%\0' の ``conversion'' (変換) によって、ただちに EOF
を返します。
戻り値
これらの関数は、照合の失敗の場合には、提供されたものより少ないか、または
0 に等しいかもしれない、割り当てられた入力項目の数を返します。0 は、利用
可能な入力があった間に、変換が割り当てられなかったことを示します。通常、
これは、`%d' 変換に対するアルファベット文字のような、無効の入力文字が原因
です。値 EOF は、入力の失敗がファイルの終り (end-of-file) が起こるように
あらゆる変換の前に起こるなら、返されます。エラーまたはファイルの終り
(end-of-file) が変換が始まった後で起こるなら、成功して終了した変換の数が
返されます。
関連項目
getc(3), mbrtowc(3), printf(3), strtod(3), strtol(3), strtoul(3),
wscanf(3)
規格
関数 fscanf(), scanf(), sscanf(), vfscanf(), vscanf() と vsscanf() は、
ISO/IEC 9899:1999 (``ISO C99'') に適合しています。
バグ
scanf の以前の実装は、l 修飾子でそれらの小文字の同等物として、%D, %E, %F,
%O と %X を扱います。さらに、scanf は、その大文字小文字に依存して %d また
は %D として未知の変換文字を扱います。この機能は、削除されました。
数値の文字列は、512 文字に切り詰められます。例えば、%f と %d は、暗黙とし
て %512f と %512d です。
位置引数のための %n$ 修飾子は、実装されていません。
scanf 関数ファミリは、format 引数でマルチバイト文字を正しく処理しません。
FreeBSD 13.0 January 4, 2003 FreeBSD 13.0