wcstok - ライブラリコールの説明 - Linux コマンド集 一覧表
名前
wcstok - ワイド文字文字列をトークンに分割する
書式
#include <wchar.h>
wchar_t *wcstok(wchar_t *wcs, const wchar_t *delim, wchar_t **ptr);
説明
wcstok () 関数は、strtok () 関数に対応するワイド文字関数に、 マルチスレッドセーフの動作をさせるための引き数を追加したものである。 この関数を用いて、ワイド文字文字列 wcs をトークンに分解すること ができる。ここで、トークンは delim に列挙されている文字を含まな い部分文字列として定義される。
検索は wcs が NULL でなければ wcs から開始され、wcs が NULL ならば *ptr から開始される。まず、全ての区切りワイド文字 がスキップされる。つまり、delim に含まれるワイド文字を超えるよう にポインタが前に進められる。 ワイド文字文字列の終わりに達したら、wcstok () は NULL を返して トークンが全く見つからなかったことを示し、この後に wcstok () を呼び 出しても NULL が返されるように *ptr に適切な値を設定する。それ 以外の場合には、wcstok () 関数はトークンの先頭を識別し、これを指す ポインタを返す。ただしこれを行う前に、トークンの後にある、delim に含まれている文字を L'\0' に置き換えることによってトークンを 0 で 終端させる。さらに *ptr を更新し、後で wcstok () を呼び出した 際に、識別されたトークンの続きから検索できるようにする。
返り値
wcstok () 関数は次のトークンへのポインタを返す。トークンが見つから なければ NULL を返す。
注意
関数に与えたワイド文字列 wcs は、関数の動作によって完全に書き換 えられる。
例
以下のコードは、ワイド文字文字列に含まれるトークンを取り出しながら
ループする。
wchar_t *wcs = ...; wchar_t *token; wchar_t *state; for (token = wcstok(wcs, " \t\n", &state); token != NULL; token = wcstok(NULL, " \t\n", &state)) { ... }
準拠
C99.