release/man3/printf.3

   1 .\" Copyright (c) 1999 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" Earlier versions of this page influenced the present text.
   4 .\" It was derived from a Berkeley page with version
   5 .\"       @(#)printf.3    6.14 (Berkeley) 7/30/91
   6 .\" converted for Linux by faith@cs.unc.edu, updated by
   7 .\" Helmut.Geyer@iwr.uni-heidelberg.de, agulbra@troll.no and Bruno Haible.
   8 .\"
   9 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
  10 .\" This is free documentation; you can redistribute it and/or
  11 .\" modify it under the terms of the GNU General Public License as
  12 .\" published by the Free Software Foundation; either version 2 of
  13 .\" the License, or (at your option) any later version.
  14 .\"
  15 .\" The GNU General Public License's references to "object code"
  16 .\" and "executables" are to be interpreted as the output of any
  17 .\" document formatting or typesetting system, including
  18 .\" intermediate and printed output.
  19 .\"
  20 .\" This manual is distributed in the hope that it will be useful,
  21 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 .\" GNU General Public License for more details.
  24 .\"
  25 .\" You should have received a copy of the GNU General Public
  26 .\" License along with this manual; if not, see
  27 .\" <http://www.gnu.org/licenses/>.
  28 .\" %%%LICENSE_END
  29 .\"
  30 .\" 1999-11-25 aeb - Rewritten, using SUSv2 and C99.
  31 .\" 2000-07-26 jsm28@hermes.cam.ac.uk - three small fixes
  32 .\" 2000-10-16 jsm28@hermes.cam.ac.uk - more fixes
  33 .\"
  34 .\"*******************************************************************
  35 .\"
  36 .\" This file was generated with po4a. Translate the source file.
  37 .\"
  38 .\"*******************************************************************
  39 .TH PRINTF 3 2013\-03\-05 GNU "Linux Programmer's Manual"
  40 .SH 名前
  41 printf, fprintf, sprintf, snprintf, vprintf, vfprintf, vsprintf, vsnprintf \-
  42 指定された書式に変換して出力を行う
  43 .SH 書式
  44 \fB#include <stdio.h>\fP
  45 .sp
  46 \fBint printf(const char *\fP\fIformat\fP\fB, ...);\fP
  47 .br
  48 \fBint fprintf(FILE *\fP\fIstream\fP\fB, const char *\fP\fIformat\fP\fB, ...);\fP
  49 .br
  50 \fBint sprintf(char *\fP\fIstr\fP\fB, const char *\fP\fIformat\fP\fB, ...);\fP
  51 .br
  52 \fBint snprintf(char *\fP\fIstr\fP\fB, size_t \fP\fIsize\fP\fB, const char *\fP\fIformat\fP\fB,
  53 \&...);\fP
  54 .sp
  55 \fB#include <stdarg.h>\fP
  56 .sp
  57 \fBint vprintf(const char *\fP\fIformat\fP\fB, va_list \fP\fIap\fP\fB);\fP
  58 .br
  59 \fBint vfprintf(FILE *\fP\fIstream\fP\fB, const char *\fP\fIformat\fP\fB, va_list
  60 \fP\fIap\fP\fB);\fP
  61 .br
  62 \fBint vsprintf(char *\fP\fIstr\fP\fB, const char *\fP\fIformat\fP\fB, va_list
  63 \fP\fIap\fP\fB);\fP
  64 .br
  65 \fBint vsnprintf(char *\fP\fIstr\fP\fB, size_t \fP\fIsize\fP\fB, const char
  66 *\fP\fIformat\fP\fB, va_list \fP\fIap\fP\fB);\fP
  67 .sp
  68 .in -4n
  69 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  70 .in
  71 .sp
  72 .ad l
  73 \fBsnprintf\fP(), \fBvsnprintf\fP():
  74 .RS 4
  75 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _ISOC99_SOURCE ||
  76 _POSIX_C_SOURCE\ >=\ 200112L;
  77 .br
  78 or \fIcc \-std=c99\fP
  79 .RE
  80 .ad
  81 .SH 説明
  82 \fBprintf\fP()  関数グループは、以下で述べるように、 \fIformat\fP に従って出力を生成するものである。 \fBprintf\fP()  と
  83 \fBvprintf\fP()  は出力を \fIstdout\fP (標準出力ストリーム) に書き出す。 \fBfprintf\fP()  と
  84 \fBvfprintf\fP()  は出力を指定された出力 \fIstream\fP に書き出す。 \fBsprintf\fP(), \fBsnprintf\fP(),
  85 \fBvsprintf\fP(), \fBvsnprintf\fP()  は出力を文字列 \fIstr\fP に書き込む。
  86 .PP
  87 \fBsnprintf\fP()  と \fBvsnprintf\fP()  は最大で \fIsize\fP バイトを \fIstr\fP に書き込む (\fIsize\fP
  88 には文字列を終端する NULL バイト (\(aq\e0\(aq) もを含まれる)。
  89 .PP
  90 \fBvprintf\fP(), \fBvfprintf\fP(), \fBvsprintf\fP(), \fBvsnprintf\fP()  の各関数はそれぞれ
  91 \fBprintf\fP(), \fBfprintf\fP(), \fBsprintf\fP(), \fBsnprintf\fP(),
  92 の各関数と等価であり、可変数引き数の代わりに \fIva_list\fP を引き数として呼び出される点だけが異なる。 これらの関数では \fIva_end\fP
  93 マクロは呼び出されない。 これらの関数は \fIva_arg\fP を呼び出すので、呼び出し後の \fIap\fP の値は未定義である。 \fBstdarg\fP(3)
  94 を参照のこと。
  95 .PP
  96 これらの 8 つの関数は \fIformat\fP 文字列の制御に従って出力を書き出す。 \fIformat\fP 文字列は、これに続く引き数 (または
  97 \fBstdarg\fP(3)  の可変長引き数機構を使ってアクセスできる引き数)  をどのように変換して出力するかを指定する。
  98
  99 C99 と POSIX.1\-2001 では、 \fBsprintf\fP(), \fBsnprintf\fP(), \fBvsprintf\fP(),
 100 \fBvsnprintf\fP()  の呼び出しで、範囲が重複するオブジェクト間でコピーが発生する場合の 結果は不定であると規定されている
 101 (例えば、出力先の文字列と入力された 引き数の一つが同じバッファを参照している場合などである)。 「注意」の節を参照。
 102 .SS "Return Values"
 103 成功時には、上記の関数は書き込まれた文字数を返す (文字列の最後を示すために使用する NULL バイトは数に含まれない)。
 104
 105 \fBsnprintf\fP()  と \fBvsnprintf\fP()  は、 \fIsize\fP バイトを越える文字数を書き込まない (\fIsize\fP
 106 には文字列を終端する NULL バイト (\(aq\e0\(aq) も含まれる)。 この制限によって出力が切り詰められた場合には、
 107 もし十分なスペースがあれば書き込まれたであろう文字の個数 (文字列を終端する NULL バイトを除く) を返す。 従って、返り値が \fIsize\fP
 108 以上だった場合、出力が切り詰められたことを意味する (後述の注意も参照のこと)。
 109
 110 エラーが発生した場合は、負の数を返す。
 111 .SS フォーマット文字列のフォーマット
 112 フォーマット文字列は文字の列で、 (もしあるなら) 初期シフト状態で始まり、初期シフト状態で終わる。 フォーマット用の文字列は 0 個以上の命令
 113 (directives) によって構成される。 命令には、通常文字と変換指定 (conversion specifications) がある。
 114 通常文字は \fB%\fP 以外の文字で、出力ストリームにそのままコピーされる。 変換指定は、それぞれが 0 個以上の引き数を取る。 各変換指定は文字
 115 \fB%\fP で始まり、 \fI変換指定子 (conversion specifier)\fP で終わる。 \fB%\fP と変換指定子の間には、0 個以上の
 116 \fIフラグ 、\fP 最小 \fIフィールド幅 、\fP \fI精度 、\fP \fI長さ修飾子\fP を (この順序で) 置くことができる。
 117
 118 引き数は (型の格上げの後は) 変換指定子が表す型と正確に対応しなければならない。 デフォルトでは、\(aq*\(aq
 119 や変換指定子が出てくる毎に次の引き数を要求され、 引き数は指定された順序で使用されていく (指定された引き数の個数が不十分ならエラーとなる)。
 120 また、引き数が必要な箇所で \(aq%\(aq の代わりに "%m$"、 \(aq*\(aqの代わりに "*m$" と書くことで、
 121 明示的にどの引き数を使用するかを指定することもできる。 ここで 10進の整数 m は希望の引き数の引き数リストでの位置を示す (最初の引き数の番号が 1
 122 である)。 従って、
 123 .in +4n
 124 .nf
 125
 126 printf("%*d", width, num);
 127
 128 .fi
 129 .in
 130 と
 131 .in +4n
 132 .nf
 133
 134 printf("%2$*1$d", width, num);
 135
 136 .fi
 137 .in
 138 は等価である。 二番目の書き方では同じ引き数を繰り返し参照することができる。 C99 標準には、 Single UNIX Specification
 139 由来の \(aq$\(aq を使った書き方は含まれていない。 \(aq$\(aq を使ったスタイルを使うと、引き数を取る変換及び幅と精度の引き数を
 140 全てこのスタイルで指定しなければならないが、 引き数を消費しない "%%" フォーマットと混ざっているかもしれない。 \(aq$\(aq
 141 で指定される引き数の番号に空きがあってはならない。 例えば、もし引き数 1 と 3 が指定されると、引き数 2 もフォーマット文字列のどこかで
 142 指定されなければならない。
 143
 144 数値変換には小数点や 1000 単位の区切り文字を使うものもある。 実際にどの文字を使うかはロケールの \fBLC_NUMERIC\fP による。 POSIX
 145 ロケールでは小数点に \(aq.\(aq を用い、 区切り文字は使わない。 従って、
 146 .in +4n
 147 .nf
 148
 149 printf("%\(aq.2f", 1234567.89);
 150
 151 .fi
 152 .in
 153 は、 POSIX ロケールでは "1234567.89" 、 nl_NL ロケールでは "1234567,89"、 da_DK ロケールでは
 154 "1.234.567,89" となる。
 155 .SS フラグ文字
 156 % 文字の後ろには 0 個以上のフラグ文字が続く。
 157 .TP
 158 \fB#\fP
 159 値は「別の形式」に変換される。 \fBo\fP 変換の場合、(先頭文字が 0 になっていない場合に先頭に 0 を追加することで)  出力文字列の最初の文字を
 160 0 にする。 \fBx\fP と \fBX\fP 変換の場合、数値が 0 でないときには文字列 "0x" (\fBX\fP 変換の場合には "0X") が前に付与される。
 161 \fBa\fP, \fBA\fP, \fBe\fP, \fBE\fP, \fBf\fP, \fBF\fP, \fBg\fP, \fBG\fP 変換では、 小数点に続く数字がなくても、
 162 出力には常に小数点が含まれる (通常は、小数点の後に数字が続く場合にのみ、 小数点が表示される)。 \fBg\fP と \fBG\fP
 163 変換の場合、他の変換とは異なり、末尾のゼロが変換結果から削除されない。 その他の変換では、結果は未定義である。
 164 .TP
 165 \fB\&0\fP
 166 値をゼロで埋める。 \fBd\fP, \fBi\fP, \fBo\fP, \fBu\fP, \fBx\fP, \fBX\fP, \fBa\fP, \fBA\fP, \fBe\fP, \fBE\fP, \fBf\fP,
 167 \fBF\fP, \fBg\fP, \fBG\fP 変換では、変換した値の左側を空白文字の代わりにゼロで埋める。 \fB\&0\fP と \fB\-\fP が両方とも指定された場合は、
 168 \fB\&0\fP フラグは無視される。 精度が数値変換 (\fBd\fP, \fBi\fP, \fBo\fP, \fBu\fP, \fBx\fP, \fBX\fP)
 169 と同時に指定された場合には、 \fB\&0\fP フラグは無視される。 その他の変換では、動作は未定義である。
 170 .TP
 171 \fB\-\fP
 172 変換値をフィールド境界で左揃えにする (デフォルトは右揃えである)。 \fBn\fP 変換以外では、変換された値は
 173 左側ではなく右側を空白文字やゼロで埋められる。 \fB\-\fP と \fB\&0\fP の両方が指定された場合には、 \fB\-\fP が優先される。
 174 .TP
 175 \&\fB' '\fP
 176 (1個の半角スペース)  符号付き変換で生成された正の数字の前に空白 (または空文字列) が置かれる。
 177 .TP
 178 \fB+\fP
 179 符号付き変換によって出力される数字の前に、常に符号 (+ か \-) が置かれる。 デフォルトでは、符号は負の数字の場合のみ付与される。 \fB+\fP
 180 と半角スペースの 両方が使われている場合には、 \fB+\fP が優先される。
 181 .PP
 182 上記の 5 つのフラグは C 標準で定義されている。 SUSv2 では、さらにもう一つフラグ文字が規定されている。
 183 .TP
 184 \fB\(aq\fP
 185 10進数変換 (\fBi\fP, \fBd\fP, \fBu\fP, \fBf\fP, \fBF\fP, \fBg\fP, \fBG\fP)  において、ロケール情報に指定があれば 1000
 186 単位の区切り文字を出力する。 \fBgcc\fP(1)  の多くのバージョンは、このオプションを解釈することができず、 警告を出力することに注意せよ。
 187 %\(aqF は SUSv2 には含まれていない。
 188 .PP
 189 glibc 2.2 では、さらに一つフラグ文字が追加されている。
 190 .TP
 191 \fBI\fP
 192 .\" outdigits keyword in locale file
 193 10進整数変換 (\fBi\fP, \fBd\fP, \fBu\fP)  において、ロケールの代替出力数字があれば、それを用いて出力する。 例えば、 glibc
 194 2.2.3 以降では、ペルシア ("fa_IR") ロケールで アラビア数字 (Arabic\-Indic digits) を出力できる。
 195 .SS フィールド幅
 196 最小のフィールド幅を指定する 10進数の数値文字列 (文字列の最初の文字は ゼロ以外)。本項目はオプションである。
 197 変換された値の文字数がフィールド長よりも少ない場合、 フィールドの左側をスペースで埋める (左揃えのフラグがある場合は右側を埋める)。
 198 10進数の文字列の代わりに "*" や "*m$" (\fIm\fP は 10進整数) を書くこともできる。 "*" と "*m$" はそれぞれ、次の引き数と
 199 \fIm\fP 番目の引き数をフィールド幅として 使うことを指定する (これらの引き数は \fIint\fP 型でなければならない)。
 200 フィールド幅に負の数が指定された場合は、 \(aq\-\(aq フラグと正の数のフィールド幅として扱われる。
 201 フィールド幅が小さかったり指定がなかったりしても、フィールドが切り詰められる ことはない。もし変換結果がフィールド幅よりも広かった場合、
 202 フィールドは変換結果が入る幅に広げられる。
 203 .SS 精度
 204 オプションである精度は、ピリオド (\(aq.\(aq) とそれに続く10進数という 形式で指定する (10進数はオプション) 。
 205 10進数の文字列の代わりに "*" や "*m$" (m は 10 進整数)を書くこともできる。 "*" と "*m$" はそれぞれ、次の引き数と m
 206 番目の引き数を精度として 使うことを指定する (これらの引き数は \fIint\fP 型でなければならない)。 精度として \(aq.\(aq
 207 だけが指定されたり、精度が負の数だった場合、 精度はゼロとみなされる。 \fBd\fP, \fBi\fP, \fBo\fP, \fBu\fP, \fBx\fP, \fBX\fP
 208 変換では、表示される最小の桁数を指定する。 \fBa\fP, \fBA\fP, \fBe\fP, \fBE\fP, \fBf\fP, \fBF\fP
 209 変換では、小数点以下に表示される数字の桁数を指定する。 \fBg\fP と \fBG\fP 変換では、有効数字の最大桁数を指定する。 \fBs\fP と \fBS\fP
 210 変換では、文字列から出力される最大文字数を指定する。
 211 .SS 長さ修飾子
 212 「整数変換」とは、 \fBd\fP, \fBi\fP, \fBo\fP, \fBu\fP, \fBx\fP, \fBX\fP 変換のことである。
 213 .TP
 214 \fBhh\fP
 215 整数変換に対応する引き数が \fIsigned char\fP か \fIunsigned char\fP で、 \fBn\fP 変換に対応する引き数が \fIsigned
 216 char\fP へのポインタであることを示す。
 217 .TP
 218 \fBh\fP
 219 整数変換に対応する引き数が \fIshort int\fP か \fIunsigned short int\fP で、 \fBn\fP 変換に対応する引き数が
 220 \fIshort int\fP へのポインタであることを示す。
 221 .TP
 222 \fBl\fP
 223 各変換に対応する引き数が、 整数変換では \fIlong int\fPか \fIunsigned long int\fP、 \fBn\fP 変換では \fIlong
 224 long int\fP へのポインタ、 \fBc\fP 変換では \fIwint_t\fP、 \fBs\fP 変換では \fIwchar_t\fP へのポインタであることを示す。
 225 .TP
 226 \fBll\fP (エルエル)
 227 整数変換に対応する引き数が \fIlong long int\fP か \fIunsigned long long int\fP で、 \fBn\fP
 228 変換に対応する引き数が \fIlong int\fP へのポインタであることを示す。
 229 .TP
 230 \fBL\fP
 231 \fBa\fP, \fBA\fP, \fBe\fP, \fBE\fP, \fBf\fP, \fBF\fP, \fBg\fP, \fBG\fP 変換に対応する引き数が \fIlong double\fP
 232 であることを示す。 (C99 では %LF を使うことを認めているが、SUSv2 では認められていない。)
 233 .TP
 234 \fBq\fP
 235 ("quad"。 4.4BSD と Linux libc5 のみ有効。使ってはならない。)  \fBll\fP と同じ意味である。
 236 .TP
 237 \fBj\fP
 238 整数変換に対応する引き数が \fIintmax_t\fP か \fIuintmax_t\fP であることを示す。
 239 .TP
 240 \fBz\fP
 241 整数変換に対応する引き数が \fIsize_t\fP か \fIssize_t\fP であることを示す。 (Linux libc5 では、これを指定するのに
 242 \fBZ\fP を用いる。使ってはならない。)
 243 .TP
 244 \fBt\fP
 245 整数変換に対応する引き数が \fIptrdiff_t\fP であることを示す。
 246 .PP
 247 SUSv2 で長さ修飾子として使用できるのは、 \fBh\fP (\fBhd\fP, \fBhi\fP, \fBho\fP, \fBhx\fP, \fBhX\fP, \fBhn\fP),
 248 \fBl\fP (\fBld\fP, \fBli\fP, \fBlo\fP, \fBlx\fP, \fBlX\fP, \fBln\fP, \fBlc\fP, \fBls\fP), \fBL\fP (\fBLe\fP,
 249 \fBLE\fP, \fBLf\fP, \fBLg\fP, \fBLG\fP)  だけである。
 250 .SS 変換指定子
 251 適用される変換の型を指定する文字。 変換指定子とその意味は以下の通りである。
 252 .TP
 253 \fBd\fP, \fBi\fP
 254 \fIint\fP 引き数を符号付き 10 進表記に変換する。 精度指定があれば、精度で指定した桁数は必ず出力される。変換後の値が
 255 指定された桁数に足りない場合は、左側が 0 で埋められる。 デフォルトの精度は 1 である。 0 を表示しようとした時に、明示的に精度として 0
 256 が指定されていると、 出力は空文字列となる。
 257 .TP
 258 \fBo\fP, \fBu\fP, \fBx\fP, \fBX\fP
 259 \fIunsigned int\fP 引き数を、 符号なし8進数 (\fBo\fP), 符号なし10進数 (\fBu\fP), 符号なし16進数 (\fBx\fP と
 260 \fBX\fP)  に変換する。 \fBx\fP 変換では \fBabcdef\fP が使用され、 \fBX\fP 変換では \fBABCDEF\fP が使用される。
 261 精度指定があれば、精度で指定した桁数は必ず出力される。変換後の値が 指定された桁数に足りない場合は、左側が 0 で埋められる。
 262 .TP
 263 \fBe\fP, \fBE\fP
 264 \fIdouble\fP 引き数を丸めて [\-]d\fB\&.\fPddd\fBe\fP\(+-dd の形に変換する。
 265 小数点の前には一桁の数字があり、小数点以下の桁数は精度で指定された桁数
 266 になる。精度は指定されなかった場合 6 とみなされる。 精度が 0 の場合には、
 267 小数点以下は表示されない。\fBE\fP 変換では、指数を表現するときに (\fBe\fP で
 268 はなく) \fBE\fP が使われる。指数部分は少なくとも 2桁表示される。つまり、
 269 指数の値が 0 の場合には、00 と表示される。
 270 .TP
 271 \fBf\fP, \fBF\fP
 272 \fIdouble\fP 引き数を丸めて [\-]ddd\fB\&.\fPddd の形の10進表現に変換する。 小数点の後の桁数は、精度で指定された値となる。
 273 精度が指定されていない場合には 6 として扱われる。 精度として明示的に 0 が指定されたときには、小数点以下は表示されない。
 274 小数点を表示する際には、小数点の前に少なくとも一桁は数字が表示される。
 275
 276 (SUSv2 では、\fBF\fP は規定されておらず、無限や NaN に関する文字列表現を
 277 行ってもよいことになっている。
 278  C99 標準では、\fBf\fP 変換では、無限は "[\-]inf" か "[\-]infinity" と表示し、
 279 NaN は文字列の先頭に `nan' をつけて表示するように規定されている。
 280 \fBF\fP 変換の場合は "[\-]INF", "[\-]INFINITY", "NAN*" と表示される。)
 281 .TP
 282 \fBg\fP, \fBG\fP
 283 \fIdouble\fP 引き数を \fBf\fP か \fBe\fP (\fBG\fP 変換の場合は \fBF\fP か \fBE\fP)  の形式に変換する。
 284 精度は表示する桁数を指定する。 精度が指定されない場合は、6桁とみなされる。 精度が 0 の場合は、1桁とみなされる。 変換される値の指数が、 \-4
 285 より小さいか、精度以上の場合に、 \fBe\fP 形式が使用される。 変換された結果の小数部分の末尾の 0 は削除される。小数点が表示されるのは、
 286 小数点以下に数字が少なくとも一つある場合にだけである。
 287 .TP
 288 \fBa\fP, \fBA\fP
 289 (C99 にはあるが SUSv2 にはない) \fBa\fP 変換では、 \fIdouble\fP 引き数を
 290 (abcdef の文字を使って) [\-]\fB0x\fPh\fB\&.\fPhhhh\fBp\fP\(+- 形式の
 291 16 進表記に変換する。
 292 \fBA\fP 変換では、前置文字列 \fB0X\fP, 文字 ABCDEF, 指数文字 \fBP\fP を用いる。
 293 小数点の前には 1 桁の 16 進数が置かれ、小数点の後ろの桁数は 精度で指定
 294 された値となる。デフォルトの精度は、その値が 2 進数で正確に表現できる
 295 場合には、その値を正確に表現できる桁数となる。それ以外の場合は、
 296 \fIdouble\fP 型の値を区別するのに十分な大きさとなる。 小数点の前の数字は、
 297 正規化されていない数の場合はいくつになるか分からない。 正規化された数の
 298 場合は、 0 以外の値になるが、いくつになるかは分からない。
 299 .TP
 300 \fBc\fP
 301 \fBl\fP 修飾子がなければ、 \fIint\fP 引き数を \fIunsigned char\fP に変換して、その結果に対応する文字を出力する。 \fBl\fP
 302 修飾子があれば、 \fIwint_t\fP (ワイド文字) 引き数を、 \fBwcrtomb\fP(3)
 303 関数を初期シフト状態で呼び出してマルチバイト文字列に変換し、 変換されたマルチバイト文字列を出力する。
 304 .TP
 305 \fBs\fP
 306 \fBl\fP 修飾子がない場合、 引き数は \fIconst char *\fP 型で文字型の配列へのポインタ (文字列へのポインタ) であることが
 307 期待されている。配列中の文字は、終端の NULL バイト (\(aq\e0\(aq)  が出てくるまで出力される (終端文字は出力されない)。
 308 精度が指定されていると、指定された字数以上は出力されない。 精度が指定された場合には、終端バイトが存在する必要はない。
 309 精度が指定されていなかったり、精度の値が配列の大きさより大きい場合には、 配列は終端の NULL バイトを含んでいなければならない。
 310
 311 \fBl\fP 修飾子が指定されている場合、 引き数は \fIconst wchar_t *\fP 型でワイド文字の配列へのポインタであることが期待されている。
 312 配列中のワイド文字は (1文字毎に \fBwcrtomb\fP(3)  を呼び出して) マルチバイト文字に変換される (最初のワイド文字の変換の前に
 313 \fBwcrtomb\fP()  のシフト状態を初期状態に戻してから変換は行われる)。 マルチバイト文字への変換は、文字列を終端する NULL ワイド文字が
 314 出てくるまで行われ、終端 NULL ワイド文字も含めて変換される。 結果のマルチバイト文字列は、終端の NULL バイトが出てくるまで 出力される
 315 (終端の NULL バイトは出力されない)。 精度が指定された場合、指定されたバイト数以上には出力されない。
 316 但し、マルチバイト文字の一部分だけが出力されることはない。 精度は「バイト」数を指定するものであり、「ワイド文字」数や
 317 「画面での位置」を指定するものではないことに注意。 精度が指定されていて、さらに出力が配列の末尾に達する前に出力バイト数が
 318 精度の値を超える場合だけは、配列は NULL ワイド文字で終端されていなくてもよい。 それ以外の場合は、必ず配列は NULL
 319 ワイド文字で終端されていなければならない。
 320 .TP
 321 \fBC\fP
 322 (C99 にはないが SUSv2 にはある)  \fBlc\fP と同じ。使ってはならない。
 323 .TP
 324 \fBS\fP
 325 (C99 にはないが SUSv2 にはある)  \fBls\fP と同じ。使ってはならない。
 326 .TP
 327 \fBp\fP
 328 \fIvoid *\fP ポインタ引き数を (\fB%#x\fP や \fB%#lx\fP のような) 16 進数で出力する。
 329 .TP
 330 \fBn\fP
 331 これまでに出力された文字数を \fIint *\fP (または類似の型) のポインタ引き数が指す整数に保存する。 引き数の変換は行われない。
 332 .TP
 333 \fBm\fP
 334 (glibc での拡張)  \fIstrerror(errno)\fP の出力を表示する。引き数は必要ない。
 335 .TP
 336 \fB%\fP
 337 \(aq%\(aq 文字を出力する。変換される引き数は無い。 変換指定全体を書くと "%%" となる。
 338 .SH 準拠
 339 \fBfprintf\fP(), \fBprintf\fP(), \fBsprintf\fP(), \fBvprintf\fP(), \fBvfprintf\fP(),
 340 \fBvsprintf\fP()  関数は、C89 と C99 に準拠している。 \fBsnprintf\fP()  と \fBvsnprintf\fP()  は C99
 341 に準拠している。
 342 .PP
 343 \fBsnprintf\fP()  の返り値を見ると、 SUSv2 と C99 標準は互いに矛盾している。 SUSv2 では、 \fBsnprintf\fP()
 344 が \fIsize\fP=0 で呼び出された場合、 1 未満の値を何か返り値とするように規定している。 一方 C99 では、このような場合 \fIstr\fP を
 345 NULL とし、返り値として (通常通り) 出力バッファが十分な大きさが あった場合に出力されるであろう文字数を返す。
 346 .PP
 347 Linux libc4 では、 5 つの C 標準のフラグ、 長さ修飾子 \fBh\fP, \fBl\fP, \fBL\fP、変換 \fBc\fP, \fBd\fP, \fBe\fP,
 348 \fBE\fP, \fBf\fP, \fBF\fP, \fBg\fP, \fBG\fP, \fBi\fP, \fBn\fP, \fBo\fP, \fBp\fP, \fBs\fP, \fBu\fP, \fBx\fP, \fBX\fP
 349 が使える。 但し \fBF\fP は \fBf\fP と同義である。 また、 \fBD\fP, \fBO\fP, and \fBU\fP を \fBld\fP, \fBlo\fP, and
 350 \fBlu\fP と同じものとして使える (これはまずい仕様で、 後に \fB%D\fP の対応が打ち切られた時に深刻なバグを
 351 引き起こした)。ロケール依存の小数点、1000 区切り、 NaN と無限、 "%m$" と "*m$" は使えない。
 352 .PP
 353 Linux libc5 では、 5 つの C 標準のフラグと \(aq フラグ、ロケール、 "%m$" と "*m$" が使える。 また、長さ修飾子
 354 \fBh\fP, \fBl\fP, \fBL\fP, \fBZ\fP, iand \fBq\fP が使えるが、 \fBL\fP と \fBq\fP は両方とも \fIlong double\fP と
 355 \fIlong long int\fP に対応している (これはバグである)。 現在では変換 \fBF\fP, \fBD\fP, \fBO\fP, \fBU\fP
 356 は認識されないが、変換文字 \fBm\fP が追加された。これは \fIstrerror(errno)\fP を出力するものである。
 357 .PP
 358 glibc 2.0 では、変換文字 \fBC\fP と \fBS\fP が追加された。
 359 .PP
 360 glibc 2.1 では、長さ修飾子 \fBhh\fP, \fBj\fP, \fBt\fP, \fBz\fP と変換文字 \fBa\fP, \fBA\fP が追加された。
 361 .PP
 362 glibc 2.2 では、 C99 で規定された意味での変換文字 \fBF\fP と フラグ文字 \fBI\fP が追加された。
 363 .SH 注意
 364 テキストを \fIbuf\fP に追加するのに、軽率にも次のようなコードを使っているプログラムがある。
 365
 366     sprintf(buf, "%s some further text", buf);
 367
 368 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=7075
 369 しかしながら、標準規格では、 \fBsprintf\fP(), \fBsnprintf\fP(), \fBvsprintf\fP(), \fBvsnprintf\fP()
 370 の呼び出しにおいて、コピー元とコピー先のバッファが重なっていた場合の 結果は不定である、と明記されている。 使用する \fBgcc\fP(1)
 371 のバージョンや指定したコンパイラのオプション次第では、 上記のような呼び出しで、期待した結果が得られ「ない」ことがある。
 372
 373 .\" .SH HISTORY
 374 .\" UNIX V7 defines the three routines
 375 .\" .BR printf (),
 376 .\" .BR fprintf (),
 377 .\" .BR sprintf (),
 378 .\" and has the flag \-, the width or precision *, the length modifier l,
 379 .\" and the conversions doxfegcsu, and also D,O,U,X as synonyms for ld,lo,lu,lx.
 380 .\" This is still true for 2.9.1BSD, but 2.10BSD has the flags
 381 .\" #, + and <space> and no longer mentions D,O,U,X.
 382 .\" 2.11BSD has
 383 .\" .BR vprintf (),
 384 .\" .BR vfprintf (),
 385 .\" .BR vsprintf (),
 386 .\" and warns not to use D,O,U,X.
 387 .\" 4.3BSD Reno has the flag 0, the length modifiers h and L,
 388 .\" and the conversions n, p, E, G, X (with current meaning)
 389 .\" and deprecates D,O,U.
 390 .\" 4.4BSD introduces the functions
 391 .\" .BR snprintf ()
 392 .\" and
 393 .\" .BR vsnprintf (),
 394 .\" and the length modifier q.
 395 .\" FreeBSD also has functions
 396 .\" .BR asprintf ()
 397 .\" and
 398 .\" .BR vasprintf (),
 399 .\" that allocate a buffer large enough for
 400 .\" .BR sprintf ().
 401 .\" In glibc there are functions
 402 .\" .BR dprintf ()
 403 .\" and
 404 .\" .BR vdprintf ()
 405 .\" that print to a file descriptor instead of a stream.
 406 glibc の \fBsnprintf\fP()  と \fBvsnprintf\fP()  の実装は、バージョン 2.1 以降は C99 標準に準拠しており、
 407 上記の通りの動作をする。 glibc 2.0.6 までは、出力が切り詰められた場合は \-1 を返す。
 408 .SH バグ
 409 \fBsprintf\fP()  と \fBvsprintf\fP()  は勝手に十分に長い文字列領域があると仮定するので、呼び出し側は
 410 実際の領域からあふれないように注意しなければならない。 しかし、これを保証することが不可能な場合が多い。
 411 生成される文字列の長さはロケール依存であり、予測が難しいことに注意。 代わりに \fBsnprintf\fP()  と \fBvsnprintf\fP()
 412 (または \fBasprintf\fP(3)  と \fBvasprintf\fP(3))  を使うこと。
 413 .PP
 414 Linux libc4.[45] には \fBsnprintf\fP()  はないが、 libbsd が提供されており、 その中には \fBsprintf\fP()
 415 と等価な (つまり \fIsize\fP 引き数を無視する)  \fBsnprintf\fP()  がある。 したがって、初期の libc4 で
 416 \fBsnprintf\fP()  を使うと、深刻なセキュリティ問題を引き起こすことがある。
 417 .PP
 418 .\" .PP
 419 .\" Some floating-point conversions under early libc4
 420 .\" caused memory leaks.
 421 \fBprintf(\fP\fIfoo\fP\fB);\fP のようなコードはしばしばバグを引き起こす。 なぜなら \fIfoo\fP に %
 422 文字が含まれてるかもしれないからである。 \fIfoo\fP が信頼できないユーザー入力から作られている場合には、 その中に \fB%n\fP
 423 が含まれていることがあり、 \fBprintf\fP()  呼び出し時にメモリへの書き込みが起こり、 セキュリティーホールを作ることになるかもしれない。
 424 .SH 例
 425 \fIPi\fP を 5 桁で出力する。
 426 .in +4n
 427 .nf
 428
 429 #include <math.h>
 430 #include <stdio.h>
 431 fprintf(stdout, "pi = %.5f\en", 4 * atan(1.0));
 432 .fi
 433 .in
 434 .PP
 435 日付と時間を "Sunday, July 3, 10:02" の形式で出力する。 (\fIweekday\fP と \fImonth\fP
 436 は文字列へのポインタである)
 437 .in +4n
 438 .nf
 439
 440 #include <stdio.h>
 441 fprintf(stdout, "%s, %s %d, %.2d:%.2d\en",
 442         weekday, month, day, hour, min);
 443 .fi
 444 .in
 445 .PP
 446 日 \- 月 \- 年 の順序で表示を行う国も多い。 従って、国際版では書式で指定された順番で 引き数を表示できなければならない。
 447 .in +4n
 448 .nf
 449
 450 #include <stdio.h>
 451 fprintf(stdout, format,
 452         weekday, month, day, hour, min);
 453
 454 .fi
 455 .in
 456 \fIformat\fP はロケールに依存しており、引き数の順番を変えることもできる。 \fIformat\fP が
 457 .in +4n
 458 .nf
 459
 460 "%1$s, %3$d. %2$s, %4$d:%5$.2d\en"
 461
 462 .fi
 463 .in
 464 であれば、 "Sonntag, 3. Juli, 10:02" という結果になる。
 465 .PP
 466 十分に大きな文字列領域を確保して、そこにメッセージを格納するには (glibc 2.0 と glibc 2.1 の両方で正しく動作するコード):
 467 .PP
 468 If truncation occurs in glibc versions prior to 2.0.6, this is treated as an
 469 error instead of being handled gracefully.
 470 .nf
 471
 472 #include <stdio.h>
 473 #include <stdlib.h>
 474 #include <stdarg.h>
 475
 476 char *
 477 make_message(const char *fmt, ...)
 478 {
 479     int n;
 480     int size = 100;     /* Guess we need no more than 100 bytes */
 481     char *p, *np;
 482     va_list ap;
 483
 484     if ((p = malloc(size)) == NULL)
 485         return NULL;
 486
 487     while (1) {
 488
 489         /* Try to print in the allocated space */
 490
 491         va_start(ap, fmt);
 492         n = vsnprintf(p, size, fmt, ap);
 493         va_end(ap);
 494
 495         /* Check error code */
 496
 497         if (n < 0)
 498             return NULL;
 499
 500         /* If that worked, return the string */
 501
 502         if (n < size)
 503             return p;
 504
 505         /* Else try again with more space */
 506
 507         size = n + 1;       /* Precisely what is needed */
 508
 509
 510         if ((np = realloc (p, size)) == NULL) {
 511             free(p);
 512             return NULL;
 513         } else {
 514             p = np;
 515         }
 516     }
 517 }
 518 .fi
 519 .SH 関連項目
 520 \fBprintf\fP(1), \fBasprintf\fP(3), \fBdprintf\fP(3), \fBscanf\fP(3), \fBsetlocale\fP(3),
 521 \fBwcrtomb\fP(3), \fBwprintf\fP(3), \fBlocale\fP(5)
 522 .SH この文書について
 523 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
 524 である。プロジェクトの説明とバグ報告に関する情報は
 525 http://www.kernel.org/doc/man\-pages/ に書かれている。