draft/man3/strfmon.3

   1 .\" Copyright (c) 2000 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\"
   9 .\" The GNU General Public License's references to "object code"
  10 .\" and "executables" are to be interpreted as the output of any
  11 .\" document formatting or typesetting system, including
  12 .\" intermediate and printed output.
  13 .\"
  14 .\" This manual is distributed in the hope that it will be useful,
  15 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 .\" GNU General Public License for more details.
  18 .\"
  19 .\" You should have received a copy of the GNU General Public
  20 .\" License along with this manual; if not, see
  21 .\" <http://www.gnu.org/licenses/>.
  22 .\" %%%LICENSE_END
  23 .\"
  24 .\"*******************************************************************
  25 .\"
  26 .\" This file was generated with po4a. Translate the source file.
  27 .\"
  28 .\"*******************************************************************
  29 .\"
  30 .\" Japanese Version Copyright (c) 2001 NAKANO Takeo all rights reserved.
  31 .\" Translated Thu Fri 08 2001 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  32 .\"
  33 .TH STRFMON 3 2000\-12\-05 Linux "Linux Programmer's Manual"
  34 .SH 名前
  35 strfmon \- 金額の値を文字列に変換する
  36 .SH 書式
  37 \fB#include <monetary.h>\fP
  38 .sp
  39 \fBssize_t strfmon(char *\fP\fIs\fP\fB, size_t \fP\fImax\fP\fB, const char
  40 *\fP\fIformat\fP\fB,\fP \fB...);\fP
  41 .SH 説明
  42 \fBstrfmon\fP()  関数は、指定された数量を \fIformat\fP で指定されたフォーマットにしたがって整形し、 結果をサイズ \fImax\fP
  43 の文字配列 \fIs\fP に書きこむ。
  44 .PP
  45 \fIformat\fP 中の通常の文字は、変換されずにそのまま \fIs\fP にコピーされる。変換指定は \(aq%\(aq 文字で始まる。
  46 この直後には、以下のフラグを 0 個以上続けることができる。
  47 .TP
  48 \fB=\fP\fIf\fP
  49 1 バイト文字 \fIf\fP を数値埋め文字 (numeric fill character) にする (左精度と共に用いる。以下を参照)。
  50 指定されないと、スペース文字が用いられる。
  51 .TP
  52 \fB^\fP
  53 現在のロケールで定義されているであろうグループ化文字 (grouping character)
  54 を一切使わない。デフォルトではグループ化は有効になっている。
  55 .TP
  56 \fB(\fP または \fB+\fP
  57 ( フラグは、負の数値を括弧で括ることを意味する。 + フラグは符号をデフォルトのように取り扱うことを意味する
  58 (すなわち数値の前にロケールの符号マークが置かれる。 例えば正ならなにもなく、負なら \(aq\-\(aq を置く、など)。
  59 .TP
  60 \fB!\fP
  61 通貨シンボルを省略する。
  62 .TP
  63 \fB\-\fP
  64 すべてのフィールドを左詰めにする。デフォルトは右詰め。
  65 .LP
  66 次の位置には、フィールドの幅を指定できる。 10 進の数値文字列で、フィールドの最小幅をバイト単位で指定する。 デフォルトは 0。
  67 結果がこの幅よりも狭くなった場合には、 不足分がスペースで埋められる (左詰めフラグが指定されていなければ左側が埋められる)。
  68 .LP
  69 次の位置には、"#" に 10 進数値文字列を続けた形式で、 左精度 (left precision) を指定できる。 通貨の基数点 (radix)
  70 より左側の数値の桁数がこの指定より小さい場合は、 数値埋め文字で左側が埋められる。 このフィールド幅の指定では、グループ化文字はカウントされない。
  71 .LP
  72 次の位置には、"." に 10 進数値文字列を続けた形式で、 右精度 (right precision) を指定できる。
  73 整形される数値は、整形前にこの桁数に丸められる。 デフォルトではカレントロケールの \fIfrac_digits\fP と
  74 \fIint_frac_digits\fP の指定を用いる。 右精度が 0 の場合は、基数点文字 (radix character) は印字されない
  75 (ここでの基数点文字は \fBLC_MONETARY\fP で定義されており、 \fBLC_NUMERIC\fP の指定とは異なっていてもよい)。
  76 .LP
  77 最後に、変換指定は変換文字 (conversion character)  で終了しなければならない。 変換文字には以下の 3 つがある。
  78 .TP
  79 \fB%\fP
  80 (この場合は指定全体が "%%" でなければならない。)  結果の文字列に \(aq%\(aq 文字を書きこむ。
  81 .TP
  82 \fBi\fP
  83 \fIdouble\fP 型の引き数ひとつが、 ロケールの国際通貨フォーマット (international currency format)
  84 を用いて変換される。
  85 .TP
  86 \fBn\fP
  87 \fIdouble\fP 型の引き数ひとつが、 ロケールの国内通貨フォーマット (national currency format)  を用いて変換される。
  88 .SH 返り値
  89 \fBstrfmon\fP()  関数は、結果の文字列が終端の NULL バイトを含めて配列 \fIs\fP に収まった場合には、 \fIs\fP
  90 に書きこまれた文字数を返す。NULL バイトは文字数に入らない。 それ以外の場合には、 \fIerrno\fP に \fBE2BIG\fP を設定して \-1
  91 を返す。 この場合の配列の内容は未定義である。
  92 .SH 準拠
  93 POSIX.1\-2001 にはない。 他のいくつかのシステムに存在する。
  94 .SH 例
  95 次のような関数コール
  96 .in +4n
  97 .nf
  98
  99 strfmon(buf, sizeof(buf), "[%^=*#6n] [%=*#6i]",
 100         1234.567, 1234.567);
 101
 102 .fi
 103 .in
 104 は、オランダのロケールでは以下のような出力になる。
 105 .in +4n
 106
 107 [ fl **1234,57] [ NLG **1 234,57]
 108
 109 .in
 110 (fl は "florijnen" の意。NLG は Netherlands Guilder。)  グループ化文字を用いると非常に醜くなる。
 111 同時に間違いなく混乱の原因にもなってしまうだろう。 これは数値の半分以下の幅であるべきだが、 数値と同じだけの幅を取ってしまうからである。
 112 ひどいことに、 "fl" の前後にはスペースが入ってしまい、 また "NLG" の前には 1 つ、後には 2 つのスペースが置かれている。
 113 これはロケールファイルのバグであろう。 イタリア・オーストラリア・スイス・ポルトガルの 各ロケールでの結果は以下のようになる。
 114 .in +4n
 115
 116 [ L. **1235] [ ITL **1.235]
 117 .br
 118 [ $**1234.57] [ AUD **1,234.57]
 119 .br
 120 [Fr. **1234,57] [CHF **1.234,57]
 121 .br
 122 [ **1234$57Esc] [ **1.234$57PTE ]
 123 .in
 124 .SH 関連項目
 125 \fBsetlocale\fP(3), \fBsprintf\fP(3), \fBlocale\fP(7)
 126 .SH この文書について
 127 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 128 である。プロジェクトの説明とバグ報告に関する情報は
 129 http://www.kernel.org/doc/man\-pages/ に書かれている。