draft/man3/wcstok.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .\"*******************************************************************
  15 .\"
  16 .\" This file was generated with po4a. Translate the source file.
  17 .\"
  18 .\"*******************************************************************
  19 .TH WCSTOK 3 2011\-09\-28 GNU "Linux Programmer's Manual"
  20 .SH 名前
  21 wcstok \- ワイド文字文字列をトークンに分割する
  22 .SH 書式
  23 .nf
  24 \fB#include <wchar.h>\fP
  25 .sp
  26 \fBwchar_t *wcstok(wchar_t *\fP\fIwcs\fP\fB, const wchar_t *\fP\fIdelim\fP\fB, wchar_t **\fP\fIptr\fP\fB);\fP
  27 .fi
  28 .SH 説明
  29 \fBwcstok\fP()  関数は、 \fBstrtok\fP(3)  関数に対応するワイド文字関数に、
  30 マルチスレッドセーフの動作をさせるための引き数を追加したものである。 この関数を用いて、ワイド文字文字列 \fIwcs\fP をトークンに分解すること
  31 ができる。ここで、トークンは \fIdelim\fP に列挙されている文字を含まな い部分文字列として定義される。
  32 .PP
  33 検索は \fIwcs\fP が NULL でなければ \fIwcs\fP から開始され、\fIwcs\fP が NULL ならば \fI*ptr\fP
  34 から開始される。まず、全ての区切りワイド文字 がスキップされる。つまり、\fIdelim\fP に含まれるワイド文字を超えるよう にポインタが前に進められる。
  35 ワイド文字文字列の終わりに達したら、 \fBwcstok\fP()  は NULL を返して トークンが全く見つからなかったことを示し、この後に
  36 \fBwcstok\fP()  を呼び 出しても NULL が返されるように \fI*ptr\fP に適切な値を設定する。それ 以外の場合には、
  37 \fBwcstok\fP()  関数はトークンの先頭を識別し、これを指す ポインタを返す。ただしこれを行う前に、トークンの後にある、\fIdelim\fP
  38 に含まれている文字を NULL ワイド文字 (L\(aq\e0\(aq) に置き換えること によってトークンを 0 で終端させる。さらに \fI*ptr\fP
  39 を更新し、後で \fBwcstok\fP()  を呼び出した 際に、識別されたトークンの続きから検索できるようにする。
  40 .SH 返り値
  41 \fBwcstok\fP()  関数は次のトークンへのポインタを返す。トークンが見つから なければ NULL を返す。
  42 .SH 準拠
  43 C99.
  44 .SH 注意
  45 関数に与えたワイド文字列 \fIwcs\fP は、関数の動作によって完全に書き換 えられる。
  46 .SH 例
  47 以下のコードは、ワイド文字文字列に含まれるトークンを取り出しながら ループする。
  48 .sp
  49 .nf
  50 wchar_t *wcs = ...;
  51 wchar_t *token;
  52 wchar_t *state;
  53 for (token = wcstok(wcs, " \et\en", &state);
  54     token != NULL;
  55     token = wcstok(NULL, " \et\en", &state)) {
  56     ...
  57 }
  58 .fi
  59 .SH 関連項目
  60 \fBstrtok\fP(3), \fBwcschr\fP(3)
  61 .SH この文書について
  62 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.41 の一部
  63 である。プロジェクトの説明とバグ報告に関する情報は
  64 http://www.kernel.org/doc/man\-pages/ に書かれている。