draft/man3/strtol.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sun Jul 25 10:53:39 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Added correction due to nsd@bbc.com (Nick Duffek) - aeb, 950610
  31 .\"*******************************************************************
  32 .\"
  33 .\" This file was generated with po4a. Translate the source file.
  34 .\"
  35 .\"*******************************************************************
  36 .TH STRTOL 3 2013\-02\-10 GNU "Linux Programmer's Manual"
  37 .SH 名前
  38 strtol, strtoll, strtoq \- 文字列を long int に変換する
  39 .SH 書式
  40 .nf
  41 \fB#include <stdlib.h>\fP
  42 .sp
  43 \fBlong int strtol(const char *\fP\fInptr\fP\fB, char **\fP\fIendptr\fP\fB, int \fP\fIbase\fP\fB);\fP
  44 .sp
  45 \fBlong long int strtoll(const char *\fP\fInptr\fP\fB, char **\fP\fIendptr\fP\fB, int \fP\fIbase\fP\fB);\fP
  46 .fi
  47 .sp
  48 .in -4n
  49 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  50 .in
  51 .sp
  52 .ad l
  53 \fBstrtoll\fP():
  54 .RS 4
  55 XOPEN_SOURCE\ >=\ 600 || _BSD_SOURCE || _SVID_SOURCE || _ISOC99_SOURCE
  56 || _POSIX_C_SOURCE\ >=\ 200112L;
  57 .br
  58 または \fIcc\ \-std=c99\fP
  59 .RE
  60 .ad
  61 .SH 説明
  62 \fBstrtol\fP()  関数は、 \fInptr\fP の文字列の最初の部分を、 \fIbase\fP を基数として long int に変換する。 この
  63 \fIbase\fP は 2 から 36 までの値 あるいは特別な意味を持つ値 0 でなければならない。
  64 .PP
  65 文字列の先頭には、任意の数の空白があってもよく (空白は \fBisspace\fP(3) で判定される)、また数字の直前には \(aq+\(aq か
  66 \(aq\-\(aq の 符号があってもよい。 \fIbase\fP が 0 または 16 の場合には、文字列の先頭に "0x" を置くことが
  67 でき、その場合には文字列は 16進数として扱われる。 これ以外の文字列で \fIbase\fP が 0 の場合は、 文字列が \(aq0\(aq
  68 で始まるときは 8進数として、 それ以外のときは 10進数として扱われる。
  69 .PP
  70 数字を表す文字列は \fIlong int\fP に変換されるが、基数に対して 有効でない数字が現れた時点で変換は終了する。(11進数以上では
  71 \(aqA\(aq は 大文字・小文字に関わらず 10 を表し、 \(aqB\(aq は 11 を表現し、 以下同様に、 \(aqZ\(aq は 35
  72 を表す。)
  73 .PP
  74 \fIendptr\fP がヌル値 (NULL) でない場合は、最初に現れた不正な文字が \fBstrtol\fP()  によって \fI*endptr\fP
  75 に保存されている。 文字列に有効な数字がひとつもなければ、 \fBstrtol\fP()  は \fInptr\fP の元の値を \fI*endptr\fP に代入する
  76 (そして 0 を返す)。 特に、\fI*nptr\fP が \(aq\e0\(aq 以外で、返された \fI**endptr\fP が \(aq\e0\(aq
  77 ならば、文字列全体が有効だったことになる。
  78 .PP
  79 \fBstrtoll\fP()  関数は \fBstrtol\fP()  と同様だが、long long int 型の値を返す。
  80 .SH 返り値
  81 アンダーフローもオーバーフローも起きなかった場合、 \fBstrtol\fP()  関数は 変換された値を返す。オーバーフローした場合には
  82 \fBLONG_MAX\fP が返り、 アンダーフローした場合には \fBLONG_MIN\fP が返る。オーバーフロー、 アンダーフローのいずれの場合にも
  83 大域変数 \fIerrno\fP には \fBERANGE\fP が設定される。 \fBstrtoll\fP()  も同様であるが、 \fBLONG_MIN\fP と
  84 \fBLONG_MAX\fP の代わりに \fBLLONG_MIN\fP と \fBLLONG_MAX\fP が返される。
  85 .SH エラー
  86 .TP
  87 \fBEINVAL\fP
  88 (C99 にはない) 指定された \fIbase\fP がサポートされていない値である。
  89 .TP
  90 \fBERANGE\fP
  91 結果の値が範囲外である。
  92 .LP
  93 実装によっては、変換が行われなかった場合 (数字がなく、0 を返した場合)、 \fIerrno\fP に \fBEINVAL\fP が設定される場合がある。
  94 .SH 準拠
  95 \fBstrtol\fP()  は SVr4, 4.3BSD, C89, C99 と POSIX.1\-2001 に準拠している。 \fBstrtoll\fP()
  96 は C99 と POSIX.1\-2001 に準拠している。
  97 .SH 注意
  98 \fBstrtol ()\fP からは成功、失敗どちらの場合でも 0, \fBLONG_MAX\fP, \fBLONG_MIN\fP (\fBstrtoll\fP()  では
  99 \fBLLONG_MAX\fP, \fBLLONG_MIN\fP)  が返る可能性があるので、 プログラムは関数を呼び出す前に \fIerrno\fP を 0
 100 に設定し、呼び出し後に \fIerrno\fP が 0 以外の値かどうかを確認しエラーが発生したかどうかを判断する 必要がある。
 101
 102 POSIX.1\-2001 では、 "C" と "POSIX"
 103 以外のロケールでは、これらの関数は、他の実装時に定義される数字を示す文字列を受け付けるとされている。
 104 .LP
 105 BSD には、
 106 .sp
 107 .in +4n
 108 .nf
 109 \fBquad_t strtoq(const char *\fP\fInptr\fP\fB, char **\fP\fIendptr\fP\fB, int \fP\fIbase\fP\fB);\fP
 110 .sp
 111 .in
 112 .fi
 113 という完全に同様の定義を持つ関数がある。 使用中のアーキテクチャのワード長次第であるが、この関数は \fBstrtoll\fP()  か
 114 \fBstrtol\fP()  と等価となることもある。
 115 .SH 例
 116 以下のプログラムは \fBstrtol\fP()  の使用例である。 最初のコマンドライン引き数には \fBstrtol\fP()
 117 が数字として解釈する文字列を指定する。 (省略可能な) 二番目の引き数には 変換に使用される基数を指定する (この引き数は \fBatoi\fP(3)
 118 を使って数値に変換される。 \fBatoi\fP(3)  は \fBstrtol\fP()  よりも簡単なインタフェースを持つ関数で、
 119 その中ではエラーチェックは行われない)。 このプログラムの実行例をいくつか以下に示す:
 120 .in +4n
 121 .nf
 122
 123 $\fB ./a.out 123\fP
 124 strtol() returned 123
 125 $\fB ./a.out \(aq    123\(aq\fP
 126 strtol() returned 123
 127 $\fB ./a.out 123abc\fP
 128 strtol() returned 123
 129 Further characters after number: abc
 130 $\fB ./a.out 123abc 55\fP
 131 strtol: Invalid argument
 132 $\fB ./a.out \(aq\(aq\fP
 133 No digits were found
 134 $\fB ./a.out 4000000000\fP
 135 strtol: Numerical result out of range
 136 .fi
 137 .in
 138 .SS プログラムのソース
 139 \&
 140 .nf
 141 #include <stdlib.h>
 142 #include <limits.h>
 143 #include <stdio.h>
 144 #include <errno.h>
 145
 146 int
 147 main(int argc, char *argv[])
 148 {
 149     int base;
 150     char *endptr, *str;
 151     long val;
 152
 153     if (argc < 2) {
 154         fprintf(stderr, "Usage: %s str [base]\en", argv[0]);
 155         exit(EXIT_FAILURE);
 156     }
 157
 158     str = argv[1];
 159     base = (argc > 2) ? atoi(argv[2]) : 10;
 160
 161     errno = 0;    /* To distinguish success/failure after call */
 162     val = strtol(str, &endptr, base);
 163
 164     /* Check for various possible errors */
 165
 166     if ((errno == ERANGE && (val == LONG_MAX || val == LONG_MIN))
 167             || (errno != 0 && val == 0)) {
 168         perror("strtol");
 169         exit(EXIT_FAILURE);
 170     }
 171
 172     if (endptr == str) {
 173         fprintf(stderr, "No digits were found\en");
 174         exit(EXIT_FAILURE);
 175     }
 176
 177     /* If we got here, strtol() successfully parsed a number */
 178
 179     printf("strtol() returned %ld\en", val);
 180
 181     if (*endptr != \(aq\e0\(aq)        /* Not necessarily an error... */
 182         printf("Further characters after number: %s\en", endptr);
 183
 184     exit(EXIT_SUCCESS);
 185 }
 186 .fi
 187 .SH 関連項目
 188 \fBatof\fP(3), \fBatoi\fP(3), \fBatol\fP(3), \fBstrtod\fP(3), \fBstrtoul\fP(3)
 189 .SH この文書について
 190 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 191 である。プロジェクトの説明とバグ報告に関する情報は
 192 http://www.kernel.org/doc/man\-pages/ に書かれている。