draft/man3/wcstok.3

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